diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index 7a98ce331..7a94d78d9 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -26,16 +26,11 @@ We have included `launch.json` files that store configuration for `vscode` debug Also, for verifying the behavior with the real Slack server-side and developer experience with installed packages, you can run the tests amd scripts under `prod-server-integration-tests`. Refer to the README file in the directory for details. These tests are supposed to be run in the project maintainers' manual execution. They are not part of CI builds for now. -### 📄 Generating Documentation -The documentation is built using [Jekyll](https://jekyllrb.com/) and hosted with GitHub Pages. The source files are contained in the `docs` directory. Reading the Jekyll configuration in `docs/_config.yml` is helpful to understand how the documentation is organized and built. +### 📄 Managing Documentation -To build the docs locally, navigate to the `docs` directory. First ensure you have Ruby ~2.5.3 and install the dependencies by running `bundle install`. Then, run the command `bundle exec jekyll serve`. You will then be provided with a local URL that you can use to view the build. +See the [Docs README](https://github.com/slackapi/node-slack-sdk/blob/main/docs/README.md) for information on how the docs site work. -To build reference documentation, in the root of this repo, run `npm run ref-docs`. This will generate reference docs and put them in the `docs/_reference` directory. Currently, reference docs need to be built manually running this command and checked into GitHub. - -**TODO**: Update this doc once building of reference docs is automated to happen on each commit to the repo - -Reference docs are built by using various open source tools and formats. This includes [API-Extractor](https://api-extractor.com/), [mdast](https://github.com/syntax-tree/mdast), and [Remark](https://github.com/remarkjs/remark). [Read more about the reference docs pipeline](https://github.com/slackapi/node-slack-sdk/pull/831#issue-299509206). +The reference docs are generated on every site build, pulling from this repo's files. The site is built automatically on every release via `docs-deploy.yml`. ### 🚀 Releases _For beta releases, see [**Beta Releases**](https://github.com/slackapi/node-slack-sdk/blob/main/.github/maintainers_guide.md#-beta-releases) section below_ diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 000000000..87bfa2aa5 --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -0,0 +1,63 @@ +name: Deploy to GitHub Pages + +on: + pull_request: + branches: + - main + paths: + - 'docs/**' + push: + branches: + - main + paths: + - 'docs/**' + workflow_dispatch: + release: + +jobs: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + cache-dependency-path: docs/package-lock.json + + - name: Install dependencies + run: npm ci + working-directory: ./docs + + - name: Build website + run: npm run build + working-directory: ./docs + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/build + + deploy: + name: Deploy to GitHub Pages + if: github.event_name != 'pull_request' + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # verifies deployment is from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/docs/.env.sample b/docs/.env.sample deleted file mode 100644 index 23e2e6d36..000000000 --- a/docs/.env.sample +++ /dev/null @@ -1,4 +0,0 @@ -# In order to fetch repository metadata during local development, put a GitHub Personal Access Token in the -# following variable, and make sure it has `public_repo` access. - -JEKYLL_GITHUB_TOKEN= diff --git a/docs/.gitignore b/docs/.gitignore index ff17a4494..49ba8fa7c 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,6 +1,5 @@ -_site -Gemfile.lock -.env - -# Built reference docs need to be committed currently -# /_reference/*.md +node_modules/ +.docusaurus +.DS_Store +build/ +.stylelintrc.json \ No newline at end of file diff --git a/docs/.ruby-version b/docs/.ruby-version deleted file mode 100644 index aedc15bb0..000000000 --- a/docs/.ruby-version +++ /dev/null @@ -1 +0,0 @@ -2.5.3 diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index bcdec967b..000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,3 +0,0 @@ -source 'https://rubygems.org' -gem 'github-pages', group: :jekyll_plugins -gem 'dotenv' diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..7b63722e4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,120 @@ +# slack.dev + +This website is built using [Docusaurus](https://docusaurus.io/). 'Tis cool. + +Each Bolt/SDK has its own Docusaurus website, with matching CSS and nav/footer. There is also be a Docusaurus website of just the homepage and community tools. + +``` +docs/ +├── content/ (the good stuff. md and mdx files supported) +│ ├── getting-started.md +│ ├── packages/ (written .md files) +│ │ └── oauth.md +│ └── reference/ +│ └── logger/ (generated reference files) +├── static/ +│ ├── css/ +│ │ └── custom.css (the css for everything!) +│ └── img/ (the pictures for the site) +│ ├── rory.png +│ └── oslo.svg +├── src/ +│ └── theme (only contains the 404 page) +├── docusaurus.config.js (main config file. also where to set navbar/footer) +├── sidebar.js (manually set where the content docs are in the sidebar.) +└── typedoc.json (typedoc parameters for generating reference from src) +``` + +A cheat-sheet: +* _I want to edit a doc._ `content/*/*.md` +* _I want to make the reference up-to-date_. It should be! But if it isn't, run the **Deploy to Github Pages** workflow. +* _I want to change the docs sidebar._ `sidebar.js` +* _I want to change the css._ Don't use this repo, use the home repo and the changes will propagate here. +* _I want to change anything else._ `docusaurus.config.js` + +---- + +## Adding a doc + +1. Make a markdown file. Add a `# Title` or use [front matter](https://docusaurus.io/docs/next/create-doc) with `title:`. +2. Save it in `content/folder/title.md` or `content/title.md`, depending on if it's in a sidebar category. The nuance is just for internal organization. +4. Add the doc's path to the sidebar within `docusaurus.config.js`. Where ever makes most sense for you. +5. Test the changes ↓ + +--- + +## Running locally + +You'll want to be using at least Node 20. You can update Node however you want. `nvm` is one way. + +Install `nvm` if you don't have it: + +``` +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash +``` + +Then grab the latest version of Node. + +``` +nvm install node +``` + + +If you are running this project locally for the first time, you'll need to install the packages with the following command: + +``` +npm install +``` + +The following command starts a local development server and opens up a browser window. + +``` +npm run start +``` + +Edits to pages are reflected live — no restarting the server or reloading the page. (I'd say... 95% of the time, and 100% time if you're just editing a markdown file) + +Remember — you're only viewing the Node Slack SDK docs right now. + +--- + +## Deploying + +The following command generates static content into the `build` directory. + +``` +$ npm run build +``` + +Then you can test out with the following command: + +``` +npm run serve +``` + +If it looks good, make a PR request! + +### Deployment to GitHub pages + +There is a GitHub action workflow set up in each repo. + +* On PR, it tests a site build. +* On Merge, it builds the site and deploys it. Site should update in a minute or two. + +--- + +## Generating reference docs + +The reference docs are autogenerated using the [`docusaurus-plugin-typedoc`](https://typedoc-plugin-markdown.org/plugins/docusaurus) plugin. It "integrates TypeDoc into the Docusaurus lifecycle and generates static TypeDoc pages in Markdown." + +In the `docusaurus.config.js` file, there's a plugin entry for each package you want to generate a reference for. On any `npm run` or `npm run build` command, it creates reference pages in the specified locations (`/docs/content/reference/{package-name}`). It also creates a custom sidebar nav for that reference, which is then loaded in `sidebars.js`. + +You can add additional generation parameters in `typedoc.json`. + +The reference docs are generated on every site build, pulling from this repo's files. The site is built automatically on every release via `docs-deploy.yml`. + +--- + +## Something's broken + +Luke goofed. Open an issue please! `:bufo-appreciates-the-insight:` \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 8e78d02b0..000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,80 +0,0 @@ -# Welcome to the documentation site. You can build it locally use `bundle exec jekyll serve`. -# See: https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll - -# This file contains site settings and metadata. It is used to both configure how Jekyll will build the site, and also -# the metadata is made available in the templates, layouts, and pages. -# See: https://jekyllrb.com/docs/configuration/options/, https://help.github.com/en/articles/configuring-jekyll, and -# https://help.github.com/en/articles/configuring-jekyll-plugins - -title: Node Slack SDK -description: >- - This SDK is a collection of single-purpose packages. The packages are aimed at making building Slack apps - easy, performant, secure, and scalable. They can help with just about anything in the Slack platform, from dropping - notifications in channels to fully interactive bots. - -# Site content -collections: - main: - output: true - packages: - output: true - tutorials: - output: true - permalink: /tutorials/:slug - reference: - output: true - permalink: /reference/:slug - -defaults: - - - scope: - path: "" - type: main - values: - layout: default - - - scope: - path: "" - type: packages - values: - layout: contained - - - scope: - path: "" - type: tutorials - values: - layout: contained - - - scope: - path: "" - type: reference - values: - layout: contained - -baseurl: /node-slack-sdk -url: https://slack.dev - -# Metadata -repo_name: node-slack-sdk -github_username: SlackAPI - -code_of_conduct_url: https://slackhq.github.io/code-of-conduct -cla_url: https://cla-assistant.io/slackapi/node-slack-sdk - -google_analytics: UA-56978219-13 -google_tag_manager: GTM-KFZ5MK7 - -# Plugin settings -markdown: kramdown -kramdown: - parse_block_html: true -plugins: - - jemoji - - jekyll-redirect-from - -# Obtain github metadata when building locally -# You will need to copy the `.env.sample` file to `.env` and fill in your token for this to work. -repository: slackapi/node-slack-sdk - -# Avoid inheriting assets (and pages) from GitHub Pages' default Jekyll theme (primer). -theme: false diff --git a/docs/_includes/analytics.html b/docs/_includes/analytics.html deleted file mode 100644 index a24f8d2cc..000000000 --- a/docs/_includes/analytics.html +++ /dev/null @@ -1,7 +0,0 @@ - - - diff --git a/docs/_includes/focused_nav.html b/docs/_includes/focused_nav.html deleted file mode 100644 index 878b82b3c..000000000 --- a/docs/_includes/focused_nav.html +++ /dev/null @@ -1,14 +0,0 @@ - - - diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index c2f639395..000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - Slack | {{ page.title | default: site.title | escape }} - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/_includes/main_nav.html b/docs/_includes/main_nav.html deleted file mode 100644 index 9fd290f0f..000000000 --- a/docs/_includes/main_nav.html +++ /dev/null @@ -1,30 +0,0 @@ -{% assign main_documents = site.main | sort: 'order' | where_exp:"item", "item.hidden != true" %} - - -{% assign packages = site.packages | sort: 'order' %} - - -{% assign tutorials = site.tutorials | sort: 'order' %} - diff --git a/docs/_includes/page_header.html b/docs/_includes/page_header.html deleted file mode 100644 index 49cccf49e..000000000 --- a/docs/_includes/page_header.html +++ /dev/null @@ -1,17 +0,0 @@ -{% include tag_manager.html %} - -
- - - - - - - -
- Code on GitHub - Slack Platform Home -
-
diff --git a/docs/_includes/tag_manager.html b/docs/_includes/tag_manager.html deleted file mode 100644 index 4a6cc98b9..000000000 --- a/docs/_includes/tag_manager.html +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - diff --git a/docs/_layouts/contained.html b/docs/_layouts/contained.html deleted file mode 100644 index f12ba92ee..000000000 --- a/docs/_layouts/contained.html +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -sidebar_style: focused ---- - -{{ content }} diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index b3b16fe8a..000000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_style: main ---- - - - -{% include head.html %} - - - -{% include page_header.html %} - -
- -
- - -
- {% if page.title != "" %} -

{{ page.title }}

- {% endif %} - -
- {{ content }} -
-
-
-
- - - - -{% include analytics.html %} - - diff --git a/docs/_main/about.md b/docs/_main/about.md deleted file mode 100644 index 76c08d967..000000000 --- a/docs/_main/about.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: About -permalink: /about -hidden: true ---- -# {{ site.title }} - -{{ site.title }} is proudly maintained with :sparkling_heart: by the Slack Platform team - - * [Code of Conduct]({{ site.code_of_conduct_url }}) - * [Contributing](https://github.com/{{ site.github_username }}/{{ site.repo_name }}/blob/main/.github/contributing.md) - * [Contributor License Agreement]({{ site.cla_url }}) diff --git a/docs/_main/auth.md b/docs/_main/auth.md deleted file mode 100644 index 098d2a225..000000000 --- a/docs/_main/auth.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -permalink: /auth -redirect_to: https://slack.dev/node-slack-sdk/getting-started#getting-a-token-to-use-the-web-api -hidden: true ---- diff --git a/docs/_main/changelog.md b/docs/_main/changelog.md deleted file mode 100644 index f9e03ff88..000000000 --- a/docs/_main/changelog.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Changelog -permalink: /changelog -order: 10 ---- - -{% for release in site.github.releases %} - -
-

{{ release.name }}

-

{{ release.published_at | date: "%b %-d, %Y" }}

- -
-{{ release.body | markdownify }} -
- -
- -{% endfor %} - -For previous releases, see [the legacy changelog](https://github.com/slackapi/node-slack-sdk/blob/1.x/CHANGELOG.md). - -

Subscribe via RSS

diff --git a/docs/_main/index.md b/docs/_main/index.md deleted file mode 100644 index 7863a344f..000000000 --- a/docs/_main/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Node Slack SDK -permalink: / -redirect_from: /faq -hidden: true -headings: - - title: Packages - - title: Installation - - title: Requirements - - title: Getting Help ---- - -### **Deprecation Notice** - -_`@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed._ - -_At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps._ - ---- - -The Slack platform offers several APIs to build apps. Each Slack API delivers part of the capabilities from the -platform, so that you can pick just those that fit for your needs. This SDK offers a corresponding package for each of -Slack's APIs. They are small and powerful when used independently, and work seamlessly when used together, too. - -**Just starting out?** The [Getting Started tutorial](https://slackapi.github.io/node-slack-sdk/getting-started) will -walk you through building your first Slack app using Node.js. - -| Slack API | What its for | NPM Package | -|--------------|--------------|-------------------| -| Web API | Send data to or query data from Slack using any of [over 130 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://slack.dev/node-slack-sdk/web-api) | -| Events API | Listen for incoming messages and [many other events](https://api.slack.com/events) happening in Slack, using a URL. | [`@slack/events-api`](https://slack.dev/node-slack-sdk/events-api) | -| Interactive Messages | Respond to button clicks, dialogs, and other interactions with messages. | [`@slack/interactive-messages`](https://slack.dev/node-slack-sdk/interactive-messages) | -| OAuth | Setup the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://slack.dev/node-slack-sdk/oauth) | -| RTM API | Listen for incoming messages and a limited set of events happening in Slack, using websockets. | [`@slack/rtm-api`](https://slack.dev/node-slack-sdk/rtm-api) | -| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) | - -**Not sure about which APIs are right for your app?** Read our [blog -post](https://medium.com/slack-developer-blog/getting-started-with-slacks-apis-f930c73fc889) that explains the options. -If you're still not sure, [reach out for help](#getting-help) and our community can guide you. - -If you're looking for an all-in-one solution that hides the underlying Slack APIs, but simplifies building a bot-style -app inside Slack, try the [Hubot Slack adapter](https://slackapi.github.io/hubot-slack/). Hubot is a popular framework -for internal apps that automate workflows, perform ChatOps, or just generate silly memes. - -## Installation - -Use your favorite package manager to install any of the packages and save to your `package.json`: - -```shell -$ npm install @slack/web-api @slack/events-api - -# Or, if you prefer yarn -$ yarn add @slack/web-api @slack/events-api -``` - -## Requirements - -This package supports Node v14 and higher. It's highly recommended to use [the latest LTS version of -node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features -from that version. - -## Getting Help - -If you get stuck, we're here to help. The following are the best ways to get assistance working through your issue: - - * [Issue Tracker](http://github.com/slackapi/{{ site.repo_name }}/issues) for questions, feature - requests, bug reports and general discussion related to this package. - * [Email us](mailto:developers@slack.com) in Slack developer support: `developers@slack.com` - * [Bot Developers Hangout](https://community.botkit.ai/): a Slack community for developers - building all types of bots. You can find the maintainers and users of this package in **#sdk-node-slack-sdk**. diff --git a/docs/_reference/events-api.md b/docs/_reference/events-api.md deleted file mode 100644 index a160b20a6..000000000 --- a/docs/_reference/events-api.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -title: "@slack/events-api" -slug: events-api ---- - -

Classes

-

SlackEventAdapter

-

An adapter for Slack's Events API.

-

new SlackEventAdapter(signingSecret, opts)

-

Constructs a new instance of the SlackEventAdapter class

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
signingSecretstring

The token used to authenticate signed requests from Slack's Events API.

optsEventAdapterOptionsSee options.
-Options: - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
includeBodyboolean
includeHeadersboolean
waitForResponseboolean
-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
includeBodyboolean

Whether to include the API event bodies in adapter event listeners.

includeHeadersboolean

Whether to include request headers in adapter event listeners.

signingSecretstring

The token used to authenticate signed requests from Slack's Events API.

waitForResponseboolean

When true prevents the adapter from responding by itself and leaves that up to listeners.

-

Methods

-

createServer()

-

Creates an HTTP server to listen for event payloads.

-

Returns Promise<http.Server>

-

expressMiddleware()

-

Returns a middleware-compatible adapter.

-

Returns RequestHandler

-

requestListener()

-

Creates a request listener.

-

Returns RequestListener

-

start(port)

-

Starts a server on the specified port.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
portnumber

The port number to listen on.

-

Returns Promise<http.Server>

-

stop()

-

Stops the server started by SlackEventAdapter.

-

Returns Promise<void>

-

Functions

-

createEventAdapter(signingSecret, options)

-

Creates a new SlackEventAdapter.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
signingSecretstring
optionsEventAdapterOptions
-

Returns SlackEventAdapter

-

verifyRequestSignature(opts)

-

Verifies the signature of a request. Throws a CodedError if the signature is invalid.

-
Remarks
-

See [Verifying requests from Slack](https://api.slack.com/docs/verifying-requests-from-slack#sdk_support) for more information.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
optsVerifyRequestSignatureParams
-Options: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bodystring

Full, raw body string.

requestSignaturestring

Signature from the X-Slack-Signature header.

requestTimestampnumber

Timestamp from the X-Slack-Request-Timestamp header.

signingSecretstring

The signing secret used to verify request signature.

-

Returns true:
-
-true when the signature is valid.

-

Enums

-

ErrorCode

-

A dictionary of codes for errors produced by this package.

-

Members

- -

Interfaces

-

CodedError

-

All errors produced by this package are regular Error objects with an extra CodedError field.

-

Fields

- - - - - - - - - - - - - - - -
NameTypeDescription
codeErrorCode

What kind of error occurred.

-

EventAdapterOptions

-

Options when constructing SlackEventAdapter. See SlackEventAdapter's fields for more information on what each option does.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
includeBodyboolean
includeHeadersboolean
waitForResponseboolean
-

VerifyRequestSignatureParams

-

Parameters for calling verifyRequestSignature.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bodystring

Full, raw body string.

requestSignaturestring

Signature from the X-Slack-Signature header.

requestTimestampnumber

Timestamp from the X-Slack-Request-Timestamp header.

signingSecretstring

The signing secret used to verify request signature.

\ No newline at end of file diff --git a/docs/_reference/index.md b/docs/_reference/index.md deleted file mode 100644 index 7378d9ca0..000000000 --- a/docs/_reference/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Reference Documentation -parmalink: /reference/ ---- - -

Packages:

- \ No newline at end of file diff --git a/docs/_reference/interactive-messages.md b/docs/_reference/interactive-messages.md deleted file mode 100644 index 1fc59dc6e..000000000 --- a/docs/_reference/interactive-messages.md +++ /dev/null @@ -1,524 +0,0 @@ ---- -title: "@slack/interactive-messages" -slug: interactive-messages ---- - -

Classes

-

SlackMessageAdapter

-

An adapter for Slack's interactive message components such as buttons, menus, and dialogs.

-

new SlackMessageAdapter(signingSecret, opts)

-

Create a message adapter.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
signingSecretstring

Slack app signing secret used to authenticate request

optsMessageAdapterOptionsSee options.
-Options: - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
lateResponseFallbackEnabledboolean
syncResponseTimeoutnumber
-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
lateResponseFallbackEnabledboolean

Whether or not promises that resolve after the syncResponseTimeout can fallback to a request for the response_url. This only works in cases where the semantic meaning of the response and the response_url are the same.

signingSecretstring

Slack app signing secret used to authenticate request

syncResponseTimeoutnumber

The number of milliseconds to wait before flushing a synchronous response to an incoming request and falling back to an asynchronous response.

-

Methods

-

action(matchingConstraints, callback)

-

Add a handler for an interactive message action.

-

Usually there's no need to be concerned with _how_ a message is sent to Slack, but the following table describes it fully.

-

**Action**|**Return object**|**Return Promise<object>**|**Return undefined**|**Call respond(message)**|**Notes** :-----:|:-----:|:-----:|:-----:|:-----:|:-----: **Button Press**| Message in response | When resolved before syncResponseTimeout or lateResponseFallbackEnabled: false, message in response
When resolved after syncResponseTimeout and lateResponseFallbackEnabled: true, message in request to response_url | Empty response | Message in request to response_url | Create a new message instead of replacing using replace_original: false **Menu Selection**| Message in response | When resolved before syncResponseTimeout or lateResponseFallbackEnabled: false, message in response
When resolved after syncResponseTimeout and lateResponseFallbackEnabled: true, message in request to response_url | Empty response | Message in request to response_url | Create a new message instead of replacing using replace_original: false **Message Action** | Message in response | When resolved before syncResponseTimeout or lateResponseFallbackEnabled: false, message in response
When resolved after syncResponseTimeout and lateResponseFallbackEnabled: true, message in request to response_url | Empty response | Message in request to response_url | **Dialog Submission**| Error list in response | Error list in response | Empty response | Message in request to response_url | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. Warning logged if a promise isn't completed before syncResponseTimeout.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
matchingConstraintsstring | RegExp | ActionConstraints

the callback ID (as a string or RegExp) or an object describing the constraints to match actions for the handler.

callbackActionHandler

the function to run when an action is matched

-

Returns this

-

createServer()

-

Create a server that dispatches Slack's interactive message actions and menu requests to this message adapter instance. Use this method if your application will handle starting the server.

-

Returns Promise<http.Server>

-

expressMiddleware()

-

Create a middleware function that can be used to integrate with the express web framework in order for incoming requests to be dispatched to this message adapter instance.

-

Returns RequestHandler

-

options(matchingConstraints, callback)

-

Add a handler for an options request

-

Usually there's no need to be concerned with _how_ a message is sent to Slack, but the following table describes it fully

-

&nbsp;|**Return options**|**Return Promise<options>**|**Return undefined**|**Notes** :-----:|:-----:|:-----:|:-----:|:-----: **Options Request**| Options in response | Options in response | Empty response | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. If the request is from within a dialog, the text field is called label.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
matchingConstraintsstring | RegExp | OptionsConstraints

the callback ID (as a string or RegExp) or an object describing the constraints to select options requests for the handler.

callbackOptionsHandler

the function to run when an options request is matched

-

Returns this

-

requestListener()

-

Create a request listener function that handles HTTP requests, verifies requests and dispatches responses

-

Returns RequestListener

-

shortcut(matchingConstraints, callback)

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
matchingConstraintsstring | RegExp | ShortcutConstraints
callbackShortcutHandler
-

Returns this

-

start(port)

-

Start a built-in server that dispatches Slack's interactive message actions and menu requests to this message adapter interface.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
portnumber
-

Returns Promise<http.Server>

-

stop()

-

Stop the previously started built-in server.

-

Returns Promise<void>

-

viewClosed(matchingConstraints, callback)

-

Add a handler for view closed interaction. The handler should not return a value.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
matchingConstraintsstring | RegExp | ViewConstraints

the callback ID (as a string or RegExp) or an object describing the constraints to match view closed interactions for the handler.

callbackViewClosedHandler

the function to run when an view closed interaction is matched

-

Returns this

-

viewSubmission(matchingConstraints, callback)

-

Add a handler for view submission.

-

The value returned from the callback determines the response sent back to Slack. The handler can return a plain object with a response_action property to dismiss the modal, push a view into the modal, display validation errors, or update the view. Alternatively, the handler can return a Promise for this kind of object, which resolves before syncResponseTimeout or lateResponseFallbackEnabled: false, to perform the same response actions. If the Promise resolves afterwards or lateResponseFallbackEnabled: true then the modal will be dismissed. If the handler returns undefined the modal will be dismissed.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
matchingConstraintsstring | RegExp | ViewConstraints

the callback ID (as a string or RegExp) or an object describing the constraints to match view submissions for the handler.

callbackViewSubmissionHandler

the function to run when an view submission is matched

-

Returns this

-

Functions

-

createMessageAdapter(signingSecret, options)

-

Factory method to create an instance of SlackMessageAdapter

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
signingSecretstring
optionsMessageAdapterOptions
-

Returns SlackMessageAdapter

-

Enums

-

ErrorCode

-

A dictionary of codes for errors produced by this package.

-

Members

- -

ResponseStatus

-

Some HTTP response statuses.

-

Members

- -

Interfaces

-

ActionConstraints

-

Constraints on when to call an action handler.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
actionIdstring | RegExp

A string or RegExp to match against the action_id

blockIdstring | RegExp

A string or RegExp to match against the block_id

callbackIdstring | RegExp

A string or RegExp to match against the callback_id

typestring

Valid types include all [actions block elements](https://api.slack.com/reference/messaging/interactive-components), select only for menu selections, or dialog_submission only for dialog submissions

unfurlboolean

When true only match actions from an unfurl

-

DispatchResult

-

The result of a call to dispatch.

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
contentany
statusResponseStatus
-

MessageAdapterOptions

-

Options for constructing SlackMessageAdapter.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
lateResponseFallbackEnabledboolean
syncResponseTimeoutnumber
-

OptionsConstraints

-

Constraints on when to call an options handler.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
actionIdstring | RegExp

A string or RegExp to match against the action_id

blockIdstring | RegExp

A string or RegExp to match against the block_id

callbackIdstring | RegExp

A string or RegExp to match against the callback_id

within'block_actions' | 'interactive_message' | 'dialog'

The source of options request.

-

ShortcutConstraints

-

Constraints on when to call an shortcut handler.

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
callbackIdstring | RegExp

A string or RegExp to match against the callback_id

type'shortcut'

Valid type includes shortcut

-

ViewConstraints

-

Constraints on when to call a view submission or view closed handler.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
callbackIdstring | RegExp

A string or RegExp to match against the callback_id

externalIdstring | RegExp

A string to match against the external_id

viewIdstring

A string to match against the view_id

-

Type Aliases

-

ActionHandler

-

A handler function for action requests (block actions, button presses, menu selections, and dialog submissions).

-
) => any | Promise<any> | undefined
-
-

OptionsHandler

-

A handler function for menu options requests.

-
<any> | undefined
-
-

Respond

-

A function used to send message updates after an action is handled. This function can be used up to 5 times in 30 minutes.

-
<unknown>
-
-

ShortcutHandler

-

A handler function for global shortcuts.

-

TODO: describe the payload and return values more specifically?

-
<any> | undefined
-
-

ViewClosedHandler

-

A handler function for view closed requests.

-

TODO: describe the payload and return values more specifically?

-
-One of: - -

ViewSubmissionHandler

-

A handler function for view submission requests.

-

TODO: describe the payload and return values more specifically?

-
<any> | undefined
-
\ No newline at end of file diff --git a/docs/_reference/logger.md b/docs/_reference/logger.md deleted file mode 100644 index 75219e0ab..000000000 --- a/docs/_reference/logger.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -title: "@slack/logger" -slug: logger ---- - -

Classes

-

ConsoleLogger

-

Default logger which logs to stdout and stderr

-

new ConsoleLogger()

-

Constructs a new instance of the ConsoleLogger class

-

Methods

-

debug(msg)

-

Log a debug message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
msgany[]
-

Returns void

-

error(msg)

-

Log an error message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
msgany[]
-

Returns void

-

getLevel()

-

Returns LogLevel

-

info(msg)

-

Log an info message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
msgany[]
-

Returns void

-

setLevel(level)

-

Sets the instance's log level so that only messages which are equal or more severe are output to the console.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
levelLogLevel
-

Returns void

-

setName(name)

-

Set the instance's name, which will appear on each log line before the message.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
namestring
-

Returns void

-

warn(msg)

-

Log a warning message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
msgany[]
-

Returns void

-

Enums

-

LogLevel

-

Severity levels for log entries

-

Members

- -

Interfaces

-

Logger

-

Interface for objects where objects in this package's logs can be sent (can be used as logger option).

-

Methods

-

debug(msg)

-

Output debug message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
msgany[]

any data to log

-

Returns void

-

error(msg)

-

Output error message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
msgany[]

any data to log

-

Returns void

-

getLevel()

-

Return the current LogLevel.

-

Returns LogLevel

-

info(msg)

-

Output info message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
msgany[]

any data to log

-

Returns void

-

setLevel(level)

-

This disables all logging below the given level, so that after a log.setLevel("warn") call log.warn("something") or log.error("something") will output messages, but log.info("something") will not.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
levelLogLevel

as a string, like 'error' (case-insensitive)

-

Returns void

-

setName(name)

-

This allows the instance to be named so that they can easily be filtered when many loggers are sending output to the same destination.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
namestring

as a string, will be output with every log after the level

-

Returns void

-

warn(msg)

-

Output warn message

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
msgany[]

any data to log

-

Returns void

\ No newline at end of file diff --git a/docs/_reference/oauth.md b/docs/_reference/oauth.md deleted file mode 100644 index d2e47e604..000000000 --- a/docs/_reference/oauth.md +++ /dev/null @@ -1,681 +0,0 @@ ---- -title: "@slack/oauth" -slug: oauth ---- - -

Classes

-

InstallProvider

-

InstallProvider provides a way to manage configuration and functionality for adding an OAuth flow to Slack apps. It contains capabilities for OAuth URL generation, state verification, authorization code exchange, as well as interfaces for storing installation details like user and bot tokens.

-

new InstallProvider(opts)

-

Constructs a new instance of the InstallProvider class

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
optsInstallProviderOptions
-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
installationStoreInstallationStore
stateStoreStateStore
-

Methods

-

handleInstallPath(req, res, options, installOptions)

-

This method handles HTTP requests to the application's installation page. It can be used to automatically render a typical installation page with an "Add to Slack" button.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
reqIncomingMessage
resServerResponse
optionsInstallPathOptions
installOptionsInstallURLOptions
-

Returns Promise<void>

-

generateInstallUrl(options)

-

Returns a URL that is suitable for including in an Add to Slack button. Uses the instance's stateStore to generate a value for the state OAuth parameter. Can disable state generation by setting stateVerification to false. Can prescribe a specific state OAuth parameter value by setting the state argument to this function explicitly.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
optionsInstallURLOptions
stateVerificationboolean✗ (defaults to true)
statestring
-

Returns Promise<string>

-

handleCallback(req, res, options, installOptions)

-

This method handles the incoming callback request to the application after a redirection from slack.com following a successful user authorization. It can be used as a RequestListener in almost any HTTP server framework.

-

Verifies the state using the instance's stateStore, exchanges the grant in the query parameters for an access token, and stores token and associated installation data in the instance's installationStore.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
reqIncomingMessage
resServerResponse
optionsCallbackOptions
installOptionsInstallURLOptions
-

Returns Promise<void>

-

authorize(source)

-

Fetches installation data from the instance's installationStore.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
sourceInstallationQuery
-

Returns Promise<AuthorizeResult>

-

Interfaces

-

AuthorizeResult

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
botIdstring
botRefreshTokenstring
botTokenstring
botTokenExpiresAtnumber (UTC, seconds)
botUserIdstring
enterpriseIdstring
teamIdstring
userRefreshTokenstring
userTokenstring
userTokenExpiresAtnumber (UTC, seconds)
-

CallbackOptions

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
beforeInstallation(options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => Promise<boolean>Additional logic to run right before executing the Slack app installation with the given OAuth code parameter. When this method returns false, the InstallProvider skips the installation. A common use for returning false in this method is if the visiting user is not eligible to proceed with the Slack app installation flow. When returning false, this method is responsible for calling the callbackRes#end() method to build a complete HTTP response for the end-user.
afterInstallation(installation: Installation | OrgInstallation, options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => Promise<boolean>Additional logic to run right after executing the Slack app installation with the given OAuth code parameter. When this method returns false, the InstallProvider skips storing the installation in the database (or whatever implementation your InstallationStore uses). A common use for returning false in this method is if your app needs to cancel the installation and display an error page to the installing user. When returning false, this method is responsible for calling the callbackRes#end() method to build a complete HTTP response for the end-user.
failure(error: CodedError, options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => voidfailure is invoked if handleCallback fails at any point. When provided, this function must complete sending the HTTP response to the end-user by calling callbackRes#end().
failureAsync(error: CodedError, options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => Promise<void>An asynchronous version of failure. If both are defined, both will be executed.
success(installation: Installation, options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => voidsuccess is invoked after handleCallback completes and has stored the installation data. When provided, this function must complete sending the HTTP response to the end-user by calling callbackRes#end().
successAsync(installation: Installation, options: InstallURLOptions, callbackReq: IncomingMessage, callbackRes: ServerResponse) => Promise<void>An asynchronous version of success. If both are defined, both will be executed.
-

Installation

-

An individual installation of the Slack app.

-

This interface creates a representation for installations that normalizes the responses from OAuth grant exchanges across auth versions (responses from the Web API methods [`oauth.v2.access`](https://api.slack.com/methods/oauth.v2.access) and [`oauth.access`](https://api.slack.com/methods/oauth.access)). It describes some of these differences using the `AuthVersion` generic placeholder type.

-

This interface also represents both installations which occur on individual Slack workspaces and on Slack enterprise organizations. The `IsEnterpriseInstall` generic placeholder type is used to describe some of those differences.

-

This representation is designed to be used both when producing data that should be stored by an [`InstallationStore`](#installationstore), and when consuming data that is fetched from an [`InstallationStore`](#installationstore). Most often, [`InstallationStore`](#installationstore) implementations are a database. If you are going to implement an [`InstallationStore`](#installationstore), it's advised that you **store as much of the data in these objects as possible so that you can return as much as possible inside `fetchInstallation()`**.

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
appIdstring | undefined
authVersion'v1' | 'v2'
botobject
enterpriseobject
enterpriseUrlstring | undefined
incomingWebhookobject
isEnterpriseInstallboolean
metadatastring
teamobject
tokenTypestring
userobject
-

InstallationQuery

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
conversationIdstring
enterpriseIdstring
isEnterpriseInstallboolean
teamIdstring
userIdstring
-

InstallationStore

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
deleteInstallation(query: InstallationQuery, logger?: Logger) => Promise<void>
fetchInstallation(query: InstallationQuery, logger?: Logger) => Promise<Installation>
storeInstallation(installation: Installation, logger?: Logger) => Promise<void>
-

InstallPathOptions

-

Customize the response headers and body data for additional user-specific data handling such as account mapping and activity tracking.

-

Fields

- - - - - - - - - - - - - - - - - -
NameTypeDescription
beforeRedirection(request: IncomingMessage, response: ServerResopnse, options: InstallURLOptions) => Promise<boolean>When this method returns false, the InstallProvider skips state OAuth parameter generation, setting the state in HTTP cookies, generating an install URL and redirecting to the slack.com authorization URL. Common use cases for returning false include when the visiting user is not eligible to proceed with the Slack application installation flow. When returning false, this method is responsible for calling response#end() to build a complete HTTP response for the end-user.
-

InstallProviderOptions

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
authorizationUrlstringThe slack.com authorization URL. This defaults to https://slack.com/oauth/v2/authorize when OAuth v2 is used, otherwise it will be set to https://slack.com/oauth/authorize.
authVersion'v1' | 'v2'The OAuth version to employ. Defaults to v2.
clientIdstringRequired. Your application client ID can be found under the Basic Information section of your application on api.slack.com/apps.
clientOptionsOmit<WebClientOptions, 'logLevel' | 'logger'>An object adhering to the @slack/web-api WebClientOptions interface, which can be used to customize the API client interacting with Slack's APIs under the hood in this package.
clientSecretstringRequired. Your application client secret can be found under the Basic Information section of your application on api.slack.com/apps.
directInstallbooleanIf true, the install path web page rendering will be skipped and instead the user will be immediately redirected to the slack.com entry point for the OAuth process. Defaults to false.
installationStoreInstallationStoreAn object adhering to the InstallationStore interface. Used to specify how application installation details like access token should be stored. Defaults to an instance of MemoryInstallationStore.
installUrlOptionsInstallURLOptionsAn object adhering to the InstallURLOptions interface. Used to specify what permissions (scopes) the application should ask for, metadata to pass during the OAuth flow and override redirect URIs.
legacyStateVerificationbooleanWhether to skip checking browser cookies for state OAuth parameter verification. Defaults to false. Enabling this option is not recommended! This is intended to be used only for backwards-compatibility with versions 2.4 and older.
loggerLoggerAn object adhering to the Logger interface. Used to specify how the application will log events.
logLevelLogLevelAn object adhering to the LogLevel enum. Used to specify how verbosely the application should log. Defaults to INFO.
stateCookieExpirationSecondsnumberThe expiration time in seconds for the state parameter used during the OAuth process. It defines an expiration time for the cookie used to store the state. Defaults to 600.
stateCookieNamestringThe cookie name used to house the state parameter during the OAuth process. Defaults to slack-app-oauth-state.
stateSecretstringA secret value used for generating the state parameter used during the OAuth process (to prevent CSRF).
stateStoreStateStoreAn object adhering to the StateStore interface. Stores state issued to the authorization server and verified the value returned at redirection during the OAuth flow (to prevent CSRF). Defaults to ClearStateStore.
stateVerificationbooleanWhether to enable verifying the state OAuth parameter. Defaults to true.
-

InstallURLOptions

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
metadatastring
redirectUristring
scopesstring | string[]
teamIdstring
userScopesstring | string[]
-

OrgInstallation

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
appIdstring | undefined
botobject
enterpriseobject
incomingWebhookobject
tokenTypestring
userobject
-

StateStore

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
generateStateParam(installOptions: InstallURLOptions, now: Date) => Promise<string>
verifyStateParam(now: Date, state: string) => Promise<InstallURLOptions>
diff --git a/docs/_reference/rtm-api.md b/docs/_reference/rtm-api.md deleted file mode 100644 index 980069cc4..000000000 --- a/docs/_reference/rtm-api.md +++ /dev/null @@ -1,585 +0,0 @@ ---- -title: "@slack/rtm-api" -slug: rtm-api ---- - -

Classes

-

RTMClient

-

An RTMClient allows programs to communicate with the Slack Platform's RTM API. This object uses the EventEmitter pattern to dispatch incoming events and has several methods for sending outgoing messages.

-

new RTMClient(token, opts)

-

Constructs a new instance of the RTMClient class

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
tokenstring
optsRTMClientOptions
webClientWebClientAn optional parameter to provide a customized WebClient. Any desired options for the custom client must be set in this parameter (webClient) as they will take precedence over other arguments passed into RTMClient.
-Options: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
autoReconnectboolean
clientPingTimeoutnumber
loggerLogger
logLevelLogLevel
replyAckOnReconnectTimeoutnumber
retryConfigRetryOptions
serverPongTimeoutnumber
slackApiUrlstring
tlsTLSOptions
useRtmConnectboolean
-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
activeTeamIdstring

The team ID for the workspace the client is connected to.

activeUserIdstring

The user ID for the connected client.

authenticatedboolean

Whether or not the client has authenticated to the RTM API. This occurs when the connect method completes, and a WebSocket URL is available for the client's connection.

connectedboolean

Whether or not the client is currently connected to the RTM API

-

Methods

-

addOutgoingEvent(awaitReply, type, body)

-

Generic method for sending an outgoing message of an arbitrary type. This method guards the higher-level methods from concern of which state the client is in, because it places all messages into a queue. The tasks on the queue will buffer until the client is in a state where they can be sent.

-

If the awaitReply parameter is set to true, then the returned Promise is resolved with the platform's acknowledgement response. Not all message types will result in an acknowledgement response, so use this carefully. This promise may be rejected with an error containing code=RTMNoReplyReceivedError if the client disconnects or reconnects before receiving the acknowledgement response.

-

If the awaitReply parameter is set to false, then the returned Promise is resolved as soon as the message is sent from the websocket.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
awaitReplytrue

whether to wait for an acknowledgement response from the platform before resolving the returned Promise.

typestring

the message type

bodyobject

the message body

-

Returns Promise<RTMCallResult>

-

addOutgoingEvent(awaitReply, type, body)

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
awaitReplyfalse
typestring
bodyobject
-

Returns Promise<void>

-

disconnect()

-

End an RTM session. After this method is called no messages will be sent or received unless you call start() again later.

-

Returns Promise<void>

-

send(type, body)

-

Generic method for sending an outgoing message of an arbitrary type. The main difference between this method and addOutgoingEvent() is that this method does not use a queue so it can only be used while the client is ready to send messages (in the 'ready' substate of the 'connected' state). It returns a Promise for the message ID of the sent message. This is an internal ID and generally shouldn't be used as an identifier for messages (for that, there is ts on messages once the server acknowledges it).

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
typestring

the message type

bodyobject

the message body

-

Returns Promise<number>

-

sendMessage(text, conversationId)

-

Send a simple message to a public channel, private channel, DM, or MPDM.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
textstring

The message text.

conversationIdstring

A conversation ID for the destination of this message.

-

Returns Promise<RTMCallResult>

-

sendTyping(conversationId)

-

Sends a typing indicator to indicate that the user with activeUserId is typing.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
conversationIdstring

The destination for where the typing indicator should be shown.

-

Returns Promise<void>

-

start(options)

-

Begin an RTM session using the provided options. This method must be called before any messages can be sent or received.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
optionsRTMStartOptions
-

Returns Promise<WebAPICallResult>

-

subscribePresence(userIds)

-

Subscribes this client to presence changes for only the given userIds.

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
userIdsstring[]

An array of user IDs whose presence you are interested in. This list will replace the list from any previous calls to this method.

-

Returns Promise<void>

-

Enums

-

ErrorCode

-

A dictionary of codes for errors produced by this package

-

Members

- -

Interfaces

-

CodedError

-

All errors produced by this package adhere to this interface

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode
-

RTMCallResult

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
errorobject
reply_tonumber
tsstring
-

RTMClientOptions

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
autoReconnectboolean
clientPingTimeoutnumber
loggerLogger
logLevelLogLevel
replyAckOnReconnectTimeoutnumber
retryConfigRetryOptions
serverPongTimeoutnumber
slackApiUrlstring
tlsTLSOptions
useRtmConnectboolean
-

RTMNoReplyReceivedError

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode.NoReplyReceivedError
-

RTMPlatformError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.SendMessagePlatformError
dataRTMCallResult
-

RTMSendWhileDisconnectedError

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode.SendWhileDisconnectedError
-

RTMSendWhileNotReadyError

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode.SendWhileNotReadyError
-

RTMWebsocketError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.WebsocketError
originalError
-

Type Aliases

-

RTMCallError

-
RTMWebsocketError | RTMNoReplyReceivedError | RTMSendWhileDisconnectedError | RTMSendWhileNotReadyError
-
-One of: - -

RTMStartOptions

-
RTMStartArguments
-
-One of: - \ No newline at end of file diff --git a/docs/_reference/types.md b/docs/_reference/types.md deleted file mode 100644 index 7d124c6b0..000000000 --- a/docs/_reference/types.md +++ /dev/null @@ -1,1518 +0,0 @@ ---- -title: "@slack/types" -slug: types ---- - -

Interfaces

-

Action

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
action_idstring
typestring
-

ActionsBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
elements(Button | Overflow | Datepicker | Select | RadioButtons | Checkboxes | Action)[]
type'actions'
-

AttachmentAction

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirmation
data_source'static' | 'channels' | 'conversations' | 'users' | 'external'
idstring
min_query_lengthnumber
namestring
option_groupsobject
optionsOptionField[]
selected_optionsOptionField[]
style'default' | 'primary' | 'danger'
textstring
type'button' | 'select'
urlstring
valuestring
-

Block

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
block_idstring
typestring
-

Button

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
style'danger' | 'primary'
textPlainTextElement
type'button'
urlstring
valuestring
-

CallUserExternal

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
avatar_urlstring
display_namestring
external_idstring
-

CallUserSlack

-

Fields

- - - - - - - - - - - - - - - -
NameType
slack_idstring
-

ChannelsSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_channelstring
placeholderPlainTextElement
type'channels_select'
-

Checkboxes

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionsOption[]
optionsOption[]
type'checkboxes'
-

Confirm

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmPlainTextElement
denyPlainTextElement
style'primary' | 'danger'
textPlainTextElement | MrkdwnElement
titlePlainTextElement
-

Confirmation

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
dismiss_textstring
ok_textstring
textstring
titlestring
-

ContextBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
elements(ImageElement | PlainTextElement | MrkdwnElement)[]
type'context'
-

ConversationsSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
default_to_current_conversationboolean
filterobject
initial_conversationstring
placeholderPlainTextElement
response_url_enabledboolean
type'conversations_select'
-

Datepicker

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_datestring
placeholderPlainTextElement
type'datepicker'
-

Dialog

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
callback_idstring
elementsobject
notify_on_cancelboolean
statestring
submit_labelstring
titlestring
-

DividerBlock

-

Fields

- - - - - - - - - - - - - - - -
NameType
type'divider'
-

ExternalSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionOption
min_query_lengthnumber
placeholderPlainTextElement
type'external_select'
-

FileBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
external_idstring
sourcestring
type'file'
-

HeaderBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
textPlainTextElement
type'header'
-

ImageBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
alt_textstring
image_urlstring
titlePlainTextElement
type'image'
-

ImageElement

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
alt_textstring
image_urlstring
type'image'
-

InputBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
elementSelect | MultiSelect | Datepicker | PlainTextInput | RadioButtons | Checkboxes
hintPlainTextElement
labelPlainTextElement
optionalboolean
type'input'
-

LinkUnfurls

-

MessageAttachment

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
actionsAttachmentAction[]
author_iconstring
author_linkstring
author_namestring
blocks(KnownBlock | Block)[]
callback_idstring
color'good' | 'warning' | 'danger' | string
fallbackstring
fieldsobject
footer_iconstring
footerstring
image_urlstring
mrkdwn_in('pretext' | 'text' | 'fields')[]
pretextstring
textstring
thumb_urlstring
title_linkstring
titlestring
tsstring
-

MrkdwnElement

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
textstring
type'mrkdwn'
verbatimboolean
-

MultiChannelsSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_channelsstring[]
max_selected_itemsnumber
placeholderPlainTextElement
type'multi_channels_select'
-

MultiConversationsSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
default_to_current_conversationboolean
filterobject
initial_conversationsstring[]
max_selected_itemsnumber
placeholderPlainTextElement
type'multi_conversations_select'
-

MultiExternalSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionsOption[]
max_selected_itemsnumber
min_query_lengthnumber
placeholderPlainTextElement
type'multi_external_select'
-

MultiStaticSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionsOption[]
max_selected_itemsnumber
option_groupsobject
optionsOption[]
placeholderPlainTextElement
type'multi_static_select'
-

MultiUsersSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_usersstring[]
max_selected_itemsnumber
placeholderPlainTextElement
type'multi_users_select'
-

Option_2

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
descriptionPlainTextElement
textPlainTextElement | MrkdwnElement
urlstring
valuestring
-

OptionField

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
descriptionstring
textstring
valuestring
-

Overflow

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
optionsOption[]
type'overflow'
-

PlainTextElement

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
emojiboolean
textstring
type'plain_text'
-

PlainTextInput

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
initial_valuestring
max_lengthnumber
min_lengthnumber
multilineboolean
placeholderPlainTextElement
type'plain_text_input'
-

RadioButtons

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionOption
optionsOption[]
type'radio_buttons'
-

SectionBlock

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
accessoryButton | Overflow | Datepicker | Select | MultiSelect | Action | ImageElement | RadioButtons | Checkboxes
fields(PlainTextElement | MrkdwnElement)[]
textPlainTextElement | MrkdwnElement
type'section'
-

SelectOption

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
labelstring
valuestring
-

StaticSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_optionOption
option_groupsobject
optionsOption[]
placeholderPlainTextElement
type'static_select'
-

UsersSelect

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
confirmConfirm
initial_userstring
placeholderPlainTextElement
type'users_select'
-

View

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
blocks(KnownBlock | Block)[]
callback_idstring
clear_on_closeboolean
closePlainTextElement
external_idstring
notify_on_closeboolean
private_metadatastring
submit_disabledboolean
submitPlainTextElement
titlePlainTextElement
type'home' | 'modal' | 'workflow_step'
-

Type Aliases

-

CallUser

-
CallUserExternal
-
-One of: - -

KnownBlock

-
ContextBlock | ActionsBlock | DividerBlock | SectionBlock | InputBlock | FileBlock | HeaderBlock
-
-One of: - -

MultiSelect

-
MultiStaticSelect | MultiConversationsSelect | MultiChannelsSelect | MultiExternalSelect
-
-One of: - -

Select

-
StaticSelect | ConversationsSelect | ChannelsSelect | ExternalSelect
-
-One of: - \ No newline at end of file diff --git a/docs/_reference/web-api.md b/docs/_reference/web-api.md deleted file mode 100644 index dc3571c3a..000000000 --- a/docs/_reference/web-api.md +++ /dev/null @@ -1,664 +0,0 @@ ---- -title: "@slack/web-api" -slug: web-api ---- - -

Classes

-

WebClient

-

A client for Slack's Web API

-

This client provides an alias for each Web API method. Each method is a convenience wrapper for calling the apiCall method using the method name as the first parameter.

-

new WebClient(token, opts)

-

Constructs a new instance of the WebClient class

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
tokenstring

An API token to authenticate/authorize with Slack (usually start with xoxp, xoxb). To learn how to get an access token, check out our Authentication Basics documentation, and in particular the Getting your access token section.

optsWebClientOptionsSee options.
-Options: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
headersobject
loggerLogger
logLevelLogLevel
maxRequestConcurrencynumber
rejectRateLimitedCallsboolean
retryConfigRetryOptions
slackApiUrlstring
tlsTLSOptions
-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
slackApiUrlstring

The base URL for reaching Slack's Web API. Consider changing this value for testing purposes.

tokenstring

An API token to authenticate/authorize with Slack (usually start with xoxp, xoxb). To learn how to get an access token, check out our Authentication Basics documentation, and in particular the Getting your access token section.

-

Methods

-

apiCall(method, options)

-

Generic method for calling a Web API method

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
methodstring

the Web API method to call https://api.slack.com/methods

optionsWebAPICallOptions

options

-

Returns Promise<WebAPICallResult>

-

paginate(method, options)

-

Iterate over the result pages of a cursor-paginated Web API method. This method can return two types of values, depending on which arguments are used. When up to two parameters are used, the return value is an async iterator which can be used as the iterable in a for-await-of loop. When three or four parameters are used, the return value is a promise that resolves at the end of iteration. The third parameter, shouldStop, is a function that is called with each page and can end iteration by returning true. The fourth parameter, reduce, is a function that is called with three arguments: accumulator, page, and index. The accumulator is a value of any type you choose, but it will contain undefined when reduce is called for the first time. The page argument and index arguments are exactly what they say they are. The reduce function's return value will be passed in as accumulator the next time its called, and the returned promise will resolve to the last value of accumulator.

-

The for-await-of syntax is part of ES2018. It is available natively in Node starting with v10.0.0. You may be able to use it in earlier JavaScript runtimes by transpiling your source with a tool like Babel. However, the transpiled code will likely sacrifice performance.

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
methodstring

the cursor-paginated Web API method to call https://api.slack.com/docs/pagination

optionsWebAPICallOptions

options

-

Returns AsyncIterable<WebAPICallResult>

-

paginate(method, options, shouldStop)

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
methodstring
optionsWebAPICallOptions
shouldStopPaginatePredicate
-

Returns Promise<void>

-

paginate(method, options, shouldStop, reduce)

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
methodstring
optionsWebAPICallOptions
shouldStopPaginatePredicate
reducePageReducer<A>
-

Returns Promise<A>

-

Functions

-

addAppMetadata(opts)

-

Appends the app metadata into the User-Agent value

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequired
{ name, version }object
-

Returns void

-

Enums

-

ErrorCode

-

A dictionary of codes for errors produced by this package

-

Members

- -

WebClientEvent

-

Members

- -

Interfaces

-

CodedError

-

All errors produced by this package adhere to this interface

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode
-

CursorPaginationEnabled

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
cursorstring
limitnumber
-

LocaleAware

-

Fields

- - - - - - - - - - - - - - - -
NameType
include_localeboolean
-

Method

-

Generic method definition

-

PageReducer

-

PaginatePredicate

-

RetryOptions

-

Options to create retry policies. Extends from https://github.com/tim-kos/node-retry.

-

Searchable

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
highlightboolean
querystring
sort_dir'asc' | 'desc'
sort'score' | 'timestamp'
-

TimelinePaginationEnabled

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
inclusiveboolean
lateststring
oldeststring
-

TokenOverridable

-

Fields

- - - - - - - - - - - - - - - -
NameType
tokenstring
-

TraditionalPagingEnabled

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
countnumber
pagenumber
-

WebAPICallOptions

-

WebAPICallResult

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
errorstring
okboolean
response_metadataobject
-

WebAPIHTTPError

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
bodyany
codeErrorCode.HTTPError
headersIncomingHttpHeaders
statusCodenumber
statusMessagestring
-

WebAPIPlatformError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.PlatformError
dataWebAPICallResult & { -error: string; -}
-

WebAPIRateLimitedError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.RateLimitedError
retryAfternumber
-

WebAPIRequestError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.RequestError
originalError
-

WebClientOptions

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
headersobject
loggerLogger
logLevelLogLevel
maxRequestConcurrencynumber
rejectRateLimitedCallsboolean
retryConfigRetryOptions
slackApiUrlstring
tlsTLSOptions
-

Type Aliases

-

PageAccumulator

-
R extends (accumulator: (infer A) | undefined, page: WebAPICallResult, index: number) => infer A ? A : never
-
-

TLSOptions

-
SecureContextOptions, 'pfx' | 'key' | 'passphrase' | 'cert' | 'ca'>
-
-

WebAPICallError

-
WebAPIRequestError | WebAPIHTTPError | WebAPIRateLimitedError
-
-One of: - diff --git a/docs/_reference/webhook.md b/docs/_reference/webhook.md deleted file mode 100644 index 2693aaac2..000000000 --- a/docs/_reference/webhook.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "@slack/webhook" -slug: webhook ---- - -

Classes

-

IncomingWebhook

-

A client for Slack's Incoming Webhooks

-

new IncomingWebhook(url, defaults)

-

Constructs a new instance of the IncomingWebhook class

-Parameters: - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeRequired
urlstring
defaultsIncomingWebhookDefaultArguments
-

Methods

-

send(message)

-

Send a notification to a conversation

-Parameters: - - - - - - - - - - - - - - - - - -
NameTypeRequiredDescription
messagestring | IncomingWebhookSendArguments

the message (a simple string, or an object describing the message)

-

Returns Promise<IncomingWebhookResult>

-

Enums

-

ErrorCode

-

A dictionary of codes for errors produced by this package

-

Members

- -

Interfaces

-

CodedError

-

All errors produced by this package adhere to this interface

-

Fields

- - - - - - - - - - - - - - - -
NameType
codeErrorCode
-

IncomingWebhookDefaultArguments

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
agentAgent
channelstring
icon_emojistring
icon_urlstring
link_namesboolean
textstring
usernamestring
-

IncomingWebhookHTTPError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.HTTPError
originalError
-

IncomingWebhookRequestError

-

Fields

- - - - - - - - - - - - - - - - - - - - -
NameType
codeErrorCode.RequestError
originalError
-

IncomingWebhookResult

-

Fields

- - - - - - - - - - - - - - - -
NameType
textstring
-

IncomingWebhookSendArguments

-

Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameType
attachmentsMessageAttachment[]
blocks(KnownBlock | Block)[]
unfurl_linksboolean
unfurl_mediaboolean
-

Type Aliases

-

IncomingWebhookSendError

-
IncomingWebhookHTTPError
-
-One of: - \ No newline at end of file diff --git a/docs/babel.config.js b/docs/babel.config.js new file mode 100644 index 000000000..e00595dae --- /dev/null +++ b/docs/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; diff --git a/docs/_main/getting_started.md b/docs/content/getting-started.md similarity index 82% rename from docs/_main/getting_started.md rename to docs/content/getting-started.md index 0017e6cbf..f8f1a3e9e 100644 --- a/docs/_main/getting_started.md +++ b/docs/content/getting-started.md @@ -1,8 +1,5 @@ --- title: Getting Started -permalink: /getting-started -redirect_from: /getting_started -order: 1 --- This tutorial will show you how to use the packages in this Node Slack SDK to get a simple Slack app running. If you've @@ -12,14 +9,14 @@ never used the Slack APIs before, you're in the right place. Welcome, and let's The first step is to [create a new app](https://api.slack.com/apps?new_granular_bot_app=1) with Slack at the API website. Give your app a fun name and choose a Development Slack Workspace. We recommend using a workspace where you aren't going to disrupt real -work getting done -- you can create a new one for free. After you create an app, you'll be greeted with some basic information. +work getting done — you can create a new one for free. After you create an app, you'll be greeted with some basic information. In this guide we'll be **calling a method of Web API** to post a message to a channel. The Web API is the foundation of the Slack Platform, and almost every Slack app uses it. Aside from posting messages, the Web API allows your app to call [methods](https://api.slack.com/methods) that can be used for everything from creating a channel to updating a user's status. Before we can call any methods, we need to configure our new app with the proper permissions. -## Getting a token to use the Web API +## Get a token to use the Web API Navigate to **OAuth & Permissions** and scroll down to the section for scopes. Slack describes the various permissions your app could obtain from an installing bot as **scopes**. There are [over 80 scopes](https://api.slack.com/scopes)! @@ -73,7 +70,7 @@ Getting started with Node Slack SDK If you see the same output as above, we're ready to start. -## Sending a message with the Web API +## Send a message with the Web API In this guide we'll post a simple message that contains the current time. We'll also follow the best practice of keeping secrets outside of your code (do not hardcode sensitive data). @@ -130,23 +127,14 @@ Look inside Slack to verify a message was sent to `#general`. ## Next Steps -You just built your first Slack app with Node.js! 🎉💃🌮 +You just built your first Slack app with Node.js! 🎉 -There's plenty more to learn and explore about this SDK and the Slack platform. Here are some ideas about where to -look next: +There's plenty more to learn and explore about the Node Slack SDK and the Slack platform. Here are some ideas about where to look next: -* Dive into the [`@slack/events-api`](https://slack.dev/node-slack-sdk/events-api) package to learn how your app can - listen for events happening inside Slack. You'll need a URL where your app can receive events, and the [local - development tutorial](https://slack.dev/node-slack-sdk/tutorials/local-development) can help you set one up. - -* This tutorial only used two of **over 130 Web API methods** available. [Look through +* This tutorial only used two of **over 200 Web API methods** available. [Look through them](https://api.slack.com/methods) to get ideas about what to build next! -* Tokens are an important part of using the Slack platform. New apps are recommended to start with a Bot User, which - allows the app to use a bot token. Learn about the [different types of - tokens](https://api.slack.com/docs/token-types). - -* You now know how to build a Slack app for a single workspace, [learn how to implement Slack" - OAuth](https://api.slack.com/authentication/oauth-v2) to make your app installable in many workspaces. If you are using +* You now know how to build a Slack app for a single workspace, [learn how to implement Slack +OAuth](https://api.slack.com/authentication/oauth-v2) to make your app installable in many workspaces. If you are using [Passport](http://www.passportjs.org/) to handle authentication, you may find the [`@aoberoi/passport-slack`](https://github.com/aoberoi/passport-slack) strategy package helpful. diff --git a/docs/content/index.md b/docs/content/index.md new file mode 100644 index 000000000..26b51e900 --- /dev/null +++ b/docs/content/index.md @@ -0,0 +1,62 @@ +--- +title: Node Slack SDK +slug: / +--- + +The Node Slack SDK is a collection of single-purpose packages aimed at making building Slack apps performant, secure, and scalable. + +**Just starting out?** The [Getting Started tutorial](/getting-started) will walk you through building your first Slack app using Node.js. + +## Slack APIs + +The Node Slack SDK has corresponding packages for Slack APIs. They are small and powerful when used independently, and work seamlessly when used together, too. + +| Slack API | Use | NPM package | +|--------------|--------------|-------------------| +| Web API | Send data to or query data from Slack using any of [over 200 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://slack.dev/node-slack-sdk/web-api) | +| OAuth | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://slack.dev/node-slack-sdk/oauth) | +| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://slack.dev/node-slack-sdk/webhook) | +| Socket Mode | Listen for incoming messages and a limited set of events happening in Slack, using WebSocket. | [`@slack/socket-mode`](https://slack.dev/node-slack-sdk/socket-mode) | + +:::warning[Deprecation Notice] + +`@slack/events-api` and `@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed. + +At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](/tutorials/migrating-to-v6) for those looking to convert their existing apps. + +::: + +## Installation + +This package supports Node v14 and higher. It's highly recommended to use [the latest LTS version of +node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features from that version. + +Use your favorite package manager to install any of the packages and save to your `package.json`: + +You can use `npm`: + +```shell +$ npm install @slack/web-api @slack/oauth +``` + +Or you can use `yarn`: + +```shell +$ yarn add @slack/web-api @slack/oauth +``` + +## Getting help + +These docs have lots of information on the Node Slack SDK. There's also an in-depth Reference section. Please explore! + +If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue: + +* [Issue Tracker](http://github.com/slackapi/node-slack-sdk/issues) for questions, bug reports, feature requests, and general discussion related to the Node Slack SDK. Try searching for an existing issue before creating a new one. +* [Email](mailto:support@slack.com) our developer support team: `support@slack.com`. + +## Contributing + +These docs live within the [Node Slack SDK](https://github.com/slackapi/node-slack-sdk) repository and are open source. + +We welcome contributions from everyone! Please check out our +[Contributor's Guide](https://github.com/slackapi/node-slack-sdk/blob/main/.github/contributing.md) for how to contribute in a helpful and collaborative way. diff --git a/docs/_packages/events_api.md b/docs/content/packages/events-api.md similarity index 96% rename from docs/_packages/events_api.md rename to docs/content/packages/events-api.md index dd5fe5040..28e226d91 100644 --- a/docs/_packages/events_api.md +++ b/docs/content/packages/events-api.md @@ -1,19 +1,19 @@ --- title: Events API -permalink: /events-api -order: 2 -anchor_links_header: Usage +slug: /events-api --- -The `@slack/events-api` package helps your app respond to events from Slack's [Events API](https://api.slack.com/events-api) -such as new messages, emoji reactions, files, and much more. This package will help you start with convenient and secure -defaults. - -### **Deprecation Notice** +:::warning[Deprecation Notice] _`@slack/events-api` officially reached EOL on May 31st, 2021. Development has fully stopped for this package and all remaining open issues and pull requests have been closed._ -_At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps._ +_At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](/tutorials/migrating-to-v6) for those looking to convert their existing apps._ + +::: + +The `@slack/events-api` package helps your app respond to events from Slack's [Events API](https://api.slack.com/events-api) +such as new messages, emoji reactions, and files. This package will help you start with convenient and secure +defaults. ## Installation @@ -26,7 +26,7 @@ development workspace. You'll also **need a public URL** where the app can begin to find the **request signing secret** given to you by Slack under the "Basic Information" of your app configuration. It may be helpful to read the tutorial on [developing Slack apps -locally](https://slack.dev/node-slack-sdk/tutorials/local-development). After you have a URL for development, see the +locally](/tutorials/local-development). After you have a URL for development, see the section on [verifying a request URL for development](#verify-tool) so you can save it as the Request URL in your app configuration. Now you can begin adding event subscriptions, just be sure to install the app in your development workspace again each time you add new scopes (typically whenever you add new event subscriptions). @@ -84,8 +84,8 @@ const port = process.env.PORT || 3000; when the server is no longer listening.
- -Using an existing HTTP server + +Using an existing HTTP server The event adapter can receive requests from an existing Node HTTP server. You still need to specify a port, but this @@ -113,8 +113,8 @@ server.listen(port, () => {
- -Using an Express app + +Using an Express app The event adapter can receive requests from an [Express](http://expressjs.com/) application. Instead of plugging the diff --git a/docs/_packages/interactive_messages.md b/docs/content/packages/interactive-messages.md similarity index 98% rename from docs/_packages/interactive_messages.md rename to docs/content/packages/interactive-messages.md index e90be4da0..538c7b150 100644 --- a/docs/_packages/interactive_messages.md +++ b/docs/content/packages/interactive-messages.md @@ -1,19 +1,20 @@ --- title: Interactive Messages -permalink: /interactive-messages -order: 3 +slug: /interactive-messages --- # Slack Interactive Messages for Node -The `@slack/interactive-messages` helps your app respond to interactions from Slack's -[interactive messages](https://api.slack.com/messaging/interactivity), [actions](https://api.slack.com/actions), and [dialogs](https://api.slack.com/dialogs). This package will help you start with convenient and secure defaults. - -### **Deprecation Notice** +:::warning[Deprecation notice] _`@slack/interactive-messages` officially reached EOL on May 31st, 2021. Development has fully stopped for this package and all remaining open issues and pull requests have been closed._ -_At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for those looking to convert their existing apps._ +_At this time, we recommend migrating to [Bolt for JavaScript](https://github.com/slackapi/bolt-js), a framework that offers all of the functionality available in those packages (and more). To help with that process, we've provided some [migration samples](/tutorials/migrating-to-v6) for those looking to convert their existing apps._ + +::: + +The `@slack/interactive-messages` helps your app respond to interactions from Slack's +[interactive messages](https://api.slack.com/messaging/interactivity), [actions](https://api.slack.com/actions), and [dialogs](https://api.slack.com/dialogs). This package will help you start with convenient and secure defaults. ## Installation @@ -26,7 +27,7 @@ development workspace. You'll also **need a public URL** where the app can begin to find the **request signing secret** given to you by Slack under the "Basic Information" of your app configuration. It may be helpful to read the tutorial on [developing Slack apps -locally](https://slack.dev/node-slack-sdk/tutorials/local-development). +locally](/tutorials/local-development). --- @@ -81,8 +82,8 @@ const port = process.env.PORT || 3000; when the server is no longer listening.
- -Using an existing HTTP server + +Using an existing HTTP server The message adapter can receive requests from an existing Node HTTP server. You still need to specify a port, but this @@ -110,8 +111,8 @@ server.listen(port, () => {
- -Using an Express app + +Using an Express app The message adapter can receive requests from an [Express](http://expressjs.com/) application. Instead of plugging the @@ -714,4 +715,4 @@ const slackInteractions = createMessageAdapter(slackSigningSecret, { const server = await slackInteractions.start(port); console.log(`Listening for events on ${server.address().port}`); })(); -``` +``` \ No newline at end of file diff --git a/docs/_packages/oauth.md b/docs/content/packages/oauth.md similarity index 94% rename from docs/_packages/oauth.md rename to docs/content/packages/oauth.md index 64b44817e..7358b4aee 100644 --- a/docs/_packages/oauth.md +++ b/docs/content/packages/oauth.md @@ -1,8 +1,6 @@ --- title: OAuth -permalink: /oauth -order: 4 -anchor_links_header: Usage +slug: /oauth --- # Slack OAuth @@ -23,7 +21,7 @@ $ npm install @slack/oauth Before building an app, you'll need to [create a Slack app](https://api.slack.com/apps/new) and install it to your development workspace. You'll also need to copy the **Client ID** and **Client Secret** given to you by Slack under the **Basic Information** of your app configuration. -It may be helpful to read the tutorials on [getting started](https://slack.dev/node-slack-sdk/getting-started) and [getting a public URL that can be used for development](https://slack.dev/node-slack-sdk/tutorials/local-development). +It may be helpful to read the tutorials on [getting started](/getting-started) and [getting a public URL that can be used for development](/tutorials/local-development). --- @@ -43,8 +41,8 @@ const installer = new InstallProvider({ ```
- -Using a classic Slack app + +Using a classic Slack app ```javascript @@ -100,8 +98,8 @@ const installer = new InstallProvider({ ```
- -Manually generating installation page URL and contents + +Manually generating installation page URL and contents If you want to customize the installation page users will be shown, you may generate an installation URL dynamically and use the generated URL as part of the installation page displayed to the user. @@ -155,8 +153,8 @@ server.listen(3000); ```
- -Using an Express app + +Using an Express app You can easily use `installer.handleCallback` within an Express app by setting up a route for the OAuth redirect. @@ -222,8 +220,8 @@ server.listen(3000); ```
- -Using custom success or failure handlers + +Using custom success or failure handlers If you decide you need custom success or failure behaviors (ex: wanting to show a page on your site with instructions on how to use the app), you can pass in your own success/failure functions. @@ -337,8 +335,8 @@ result = { ```
- -Reading extended installation data + +Reading extended installation data The `installer.authorize()` method only returns a subset of the installation data returned by the installation store. To fetch the entire saved installation, use the `installer.installationStore.fetchInstallation()` method. @@ -427,8 +425,8 @@ const installer = new InstallProvider({ All the log levels, in order of most to least information are: `DEBUG`, `INFO`, `WARN`, and `ERROR`.
- -Sending log output somewhere besides the console + +Sending log output somewhere besides the console You can also choose to have logs sent to a custom logger using the `logger` option. A custom logger needs to implement @@ -479,14 +477,4 @@ const installer = new InstallProvider({ This package supports Node v14 and higher. It's highly recommended to use [the latest LTS version of node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features -from that version. - -## Getting Help - -If you get stuck, we're here to help. The following are the best ways to get assistance working through your issue: - - * [Issue Tracker](http://github.com/slackapi/node-slack-sdk/issues) for questions, feature requests, bug reports and - general discussion related to these packages. Try searching before you create a new issue. - * [Email us](mailto:developers@slack.com) in Slack developer support: `developers@slack.com` - * [Bot Developers Hangout](https://community.botkit.ai/): a Slack community for developers - building all types of bots. You can find the maintainers and users of these packages in **#sdk-node-slack-sdk**. +from that version. \ No newline at end of file diff --git a/docs/_packages/rtm_api.md b/docs/content/packages/rtm-api.md similarity index 94% rename from docs/_packages/rtm_api.md rename to docs/content/packages/rtm-api.md index 63c254dc9..ffc5e869a 100644 --- a/docs/_packages/rtm_api.md +++ b/docs/content/packages/rtm-api.md @@ -1,18 +1,18 @@ --- title: Real Time Messaging API -permalink: /rtm-api -redirect_from: - - /bots - - /rtm_api -order: 5 +slug: /rtm-api --- # Slack Real Time Messaging API -The `@slack/rtm-api` package contains a simple, convenient, and configurable client for receiving events and sending simple messages to Slack's [Real Time Messaging API](https://api.slack.com/rtm). Use it in your +The `@slack/rtm-api` package contains a configurable client for receiving events and sending simple messages to the Slack [Real Time Messaging API](https://api.slack.com/rtm). Use it in your app to stay connected to the Slack platform over a persistent Websocket connection. -**Note**: RTM isn't available for modern scoped apps anymore. We recommend using the [Events API](https://slack.dev/node-slack-sdk/events-api) and [Web API](https://slack.dev/node-slack-sdk/web-api) instead. If you need to use RTM (possibly due to corporate firewall limitations), you can do so by creating a [legacy scoped app](https://api.slack.com/apps?new_classic_app=1). If you have an existing RTM app, do not update its scopes as it will be updated to a modern scoped app and stop working with RTM. +:::danger + +The RTM API isn't available for modern granular-permissions apps, and you can no longer create new legacy apps. We recommend using [Bolt for JavaScript](https://slack.dev/bolt-js). If you have an existing RTM app, do not update its scopes as it will be updated to a granular-permissions app and stop working with the RTM API. + +::: ## Installation @@ -66,13 +66,13 @@ user ID and team ID, you can look those up any time the client is connected as t `rtm.connected` property.
- -Additional connection options + +Additional connection options Options passed to the `.start()` method are passed through as arguments to the [`rtm.connect` Web API method](https://api.slack.com/methods/rtm.connect). These arguments deal with presence, which is discussed in more -detail [on the documentation website](https://slack.dev/node-slack-sdk/rtm-api#presence). +detail [on the documentation website](/rtm-api#presence).
@@ -103,8 +103,8 @@ rtm.on('message', (event) => { ```
- -Listen for message subtypes + +Listen for message subtypes The `message` event type has a special property called `subtype` to help organize all the messages inside Slack. The @@ -163,8 +163,8 @@ rtm.on('member_joined_channel', async (event) => { ```
- -Send rich messages using the WebClient + +Send rich messages using the WebClient The Web API's [`chat.postMessage` method](https://api.slack.com/methods/chat.postMessage) is capable of sending [rich @@ -221,11 +221,11 @@ rtm.on('member_joined_channel', async (event) => {
- -Send a typing indicator + +Send a typing indicator -Over the RTM API, your bot user can appear to be typing in Slack before it sends a message ("{Bot Display Name} is +Over the RTM API, your bot user can appear to be typing in Slack before it sends a message ("`{Bot Display Name}` is typing" is shown near the text input). The client has a `.sendTyping(conversationId)` method to allow your bot to trigger the typing indicator. The method returns a `Promise` that resolves when Slack has acknowledged the message. The `Promise` doesn't have a resolved value. @@ -333,8 +333,8 @@ rtm.on('member_joined_channel', async (event) => { ```
- -More error types + +More error types There are a few more types of errors that you might encounter, each with one of these `code`s: @@ -375,8 +375,8 @@ const rtm = new RTMClient(token, { All the log levels, in order of most to least information are: `DEBUG`, `INFO`, `WARN`, and `ERROR`.
- -Sending log output somewhere besides the console + +Sending log output somewhere besides the console You can also choose to have logs sent to a custom logger using the `logger` option. A custom logger needs to implement @@ -430,7 +430,7 @@ previously, and you're trying to add subscriptions for new users, you should inc to `.subscribePresence(userIds)` in the next call. If instead of being informed when a user's presence changes (reactively), your app needs to know what the user's status -is currently (proactively), then your app should use the [`WebClient`](https://slack.dev/node-slack-sdk/web-api)'s +is currently (proactively), then your app should use the [`WebClient`](/web-api)'s `users.getPresence` method. In general, its easier to deal with user presence proactively than to keep track of all the changes to understand the current presence of a user. @@ -480,8 +480,8 @@ rtm.on('presence_change', (event) => { ```
- -Batch presence updates + +Batch presence updates Your app can receive even more efficient presence updates, by batching many users' updates into the same event. The @@ -673,7 +673,7 @@ const rtm = new RTMClient(token, { webClient }); The client can receive a snapshot of a portion of the workspace's state while its connecting. This can be useful if your app needs to keep track of some data as it changes while the app runs, but it needs the initial start to get started. However, **this can also cause the client to fail to connect on large teams**. Our recommendation is to call the [Web -API](https://slack.dev/node-slack-sdk/web-api) to retrieve workspace state while your app is connecting, instead of +API](/web-api) to retrieve workspace state while your app is connecting, instead of relying on the cache. See [sending rich messages](#send-messages) for an example of using the `WebClient` class inside your app, and use [some of the other methods](https://api.slack.com/methods) to get data. @@ -696,4 +696,4 @@ rtm.on('authenticated', (snapshot) => { (async () => { await rtm.start(); })(); -``` +``` \ No newline at end of file diff --git a/docs/_packages/socket_mode.md b/docs/content/packages/socket-mode.md similarity index 89% rename from docs/_packages/socket_mode.md rename to docs/content/packages/socket-mode.md index 2b1f19751..a7a3b31ff 100644 --- a/docs/_packages/socket_mode.md +++ b/docs/content/packages/socket-mode.md @@ -1,8 +1,6 @@ --- title: Socket Mode -permalink: /socket-mode -order: 7 -anchor_links_header: Usage +slug: /socket-mode --- # Slack Socket Mode @@ -13,7 +11,7 @@ The following contain additional examples that may be useful for consumers. ## Listen for Interactivity Events -To receive interactivity events such as shorcut invocations, button clicks, and modal data submission, your listener can subscribe to "interactive" events. +To receive interactivity events such as shortcut invocations, button clicks, and modal data submission, your listener can subscribe to "interactive" events. ```javascript const { WebClient } = require('@slack/web-api'); diff --git a/docs/_packages/web_api.md b/docs/content/packages/web-api.md similarity index 97% rename from docs/_packages/web_api.md rename to docs/content/packages/web-api.md index 271e182da..1e00d4a22 100644 --- a/docs/_packages/web_api.md +++ b/docs/content/packages/web-api.md @@ -1,11 +1,6 @@ --- title: Web API -permalink: /web-api -redirect_from: - - /basic_usage - - /web_api -order: 1 -anchor_links_header: Usage +slug: /web-api --- @@ -57,8 +52,8 @@ const web = new WebClient(token); ```
- -Initializing without a token + +Initializing without a token Alternatively, you can create a client without a token, and use it with multiple workspaces as long as you supply a @@ -111,14 +106,14 @@ const conversationId = '...'; **Hint**: If you're using an editor that supports TypeScript, even if you're not using TypeScript to write your code, you'll get hints for all the arguments each method supports. This helps you save time by reducing the number of times you need to pop out to a webpage to check the reference. There's more information about [using -TypeScript](https://slack.dev/node-slack-sdk/typescript) with this package in the documentation website. +TypeScript](/typescript) with this package in the documentation website. **Note**: Use the [Block Kit Builder](https://api.slack.com/tools/block-kit-builder) for a playground where you can prototype your message's look and feel.
- -Using a dynamic method name + +Using a dynamic method name If you want to provide the method name as a string, so that you can decide which method to call dynamically, or to call @@ -173,8 +168,8 @@ const { WebClient, ErrorCode } = require('@slack/web-api'); ```
- -More error types + +More error types There are a few more types of errors that you might encounter, each with one of these `code`s: @@ -184,7 +179,7 @@ There are a few more types of errors that you might encounter, each with one of * `ErrorCode.RateLimitedError`: The Web API cannot fulfill the API method call because your app has made too many requests too quickly. This error has a `retryAfter` property with the number of seconds you should wait before trying - again. See [the documentation on rate limit handling](https://slack.dev/node-slack-sdk/web-api#rate-limits) to + again. See [the documentation on rate limit handling](/web-api#rate-limits) to understand how the client will automatically deal with these problems for you. * `ErrorCode.HTTPError`: The HTTP response contained an unfamiliar status code. The Web API only responds with `200` @@ -228,8 +223,8 @@ The `for await...of` syntax is available in Node v10.0.0 and above. If you're us functional iteration below.
- -Using functional iteration + +Using functional iteration The `.paginate()` method can accept up to two additional parameters. The third parameter, `stopFn`, is a function that @@ -312,8 +307,8 @@ const trigger = 'VALID_TRIGGER_ID'; ```
- -Dynamically updating a modal + +Dynamically updating a modal After the modal is opened, you can update it dynamically by calling `views.update` with the view ID returned in the `views.open` result. @@ -374,8 +369,8 @@ const web = new WebClient(token, { All the log levels, in order of most to least information are: `DEBUG`, `INFO`, `WARN`, and `ERROR`.
- -Sending log output somewhere besides the console + +Sending log output somewhere besides the console You can also choose to have logs sent to a custom logger using the `logger` option. A custom logger needs to implement @@ -842,6 +837,10 @@ The `@slack/web-api` package supports the following API methods which you can us Here's a fully-functioning [sample application implementation](https://github.com/slackapi/node-slack-sdk/blob/main/examples/openid-connect) for your perusal! -💡 To read more about how **Sign in with Slack** works, and to access helpful resources like a Sign in With Slack +:::tip + +To read more about how **Sign in with Slack** works, and to access helpful resources like a Sign in With Slack button generator and other design assets, check out: [Authentication: Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack) documentation page. + +::: diff --git a/docs/_packages/webhook.md b/docs/content/packages/webhook.md similarity index 97% rename from docs/_packages/webhook.md rename to docs/content/packages/webhook.md index ed612dc81..195570186 100644 --- a/docs/_packages/webhook.md +++ b/docs/content/packages/webhook.md @@ -1,9 +1,6 @@ --- title: Incoming Webhooks permalink: /webhook -redirect_from: - - /incoming_webhook -order: 6 --- # Slack Incoming Webhooks @@ -43,8 +40,8 @@ const webhook = new IncomingWebhook(url); ```
- -Setting default arguments + +Setting default arguments The webhook can be initialized with default arguments that are reused each time a notification is sent. Use the second diff --git a/docs/content/reference/events-api/classes/SlackEventAdapter.md b/docs/content/reference/events-api/classes/SlackEventAdapter.md new file mode 100644 index 000000000..875f04cf0 --- /dev/null +++ b/docs/content/reference/events-api/classes/SlackEventAdapter.md @@ -0,0 +1,189 @@ +# Class: SlackEventAdapter + +An adapter for Slack's Events API. + +## Extends + +- `unknown` + +## Constructors + +### new SlackEventAdapter() + +```ts +new SlackEventAdapter(signingSecret, __namedParameters): SlackEventAdapter +``` + +#### Parameters + +• **signingSecret**: `string` + +The token used to authenticate signed requests from Slack's Events API. + +• **\_\_namedParameters**: [`EventAdapterOptions`](../interfaces/EventAdapterOptions.md) = `{}` + +#### Returns + +[`SlackEventAdapter`](SlackEventAdapter.md) + +#### Overrides + +`EventEmitter.constructor` + +#### Defined in + +[packages/events-api/src/adapter.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L47) + +## Properties + +### includeBody + +```ts +includeBody: boolean; +``` + +Whether to include the API event bodies in adapter event listeners. + +#### Defined in + +[packages/events-api/src/adapter.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L23) + +*** + +### includeHeaders + +```ts +includeHeaders: boolean; +``` + +Whether to include request headers in adapter event listeners. + +#### Defined in + +[packages/events-api/src/adapter.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L28) + +*** + +### signingSecret + +```ts +readonly signingSecret: string; +``` + +The token used to authenticate signed requests from Slack's Events API. + +#### Defined in + +[packages/events-api/src/adapter.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L18) + +*** + +### waitForResponse + +```ts +waitForResponse: boolean; +``` + +When `true` prevents the adapter from responding by itself and leaves that up to listeners. + +#### Defined in + +[packages/events-api/src/adapter.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L33) + +## Methods + +### createServer() + +```ts +createServer(): Promise +``` + +Creates an HTTP server to listen for event payloads. + +#### Returns + +`Promise`\<`Server`\> + +#### Defined in + +[packages/events-api/src/adapter.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L76) + +*** + +### expressMiddleware() + +```ts +expressMiddleware(): RequestHandler +``` + +Returns a middleware-compatible adapter. + +#### Returns + +`RequestHandler` + +#### Defined in + +[packages/events-api/src/adapter.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L120) + +*** + +### requestListener() + +```ts +requestListener(): RequestListener +``` + +Creates a request listener. + +#### Returns + +`RequestListener` + +#### Defined in + +[packages/events-api/src/adapter.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L130) + +*** + +### start() + +```ts +start(port): Promise +``` + +Starts a server on the specified port. + +#### Parameters + +• **port**: `number` + +The port number to listen on. + +#### Returns + +`Promise`\<`Server`\> + +The server from the built-in `http` module. + +#### Defined in + +[packages/events-api/src/adapter.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L87) + +*** + +### stop() + +```ts +stop(): Promise +``` + +Stops the server started by [SlackEventAdapter.start](SlackEventAdapter.md#start). + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/events-api/src/adapter.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L100) diff --git a/docs/content/reference/events-api/enumerations/ErrorCode.md b/docs/content/reference/events-api/enumerations/ErrorCode.md new file mode 100644 index 000000000..13bedc298 --- /dev/null +++ b/docs/content/reference/events-api/enumerations/ErrorCode.md @@ -0,0 +1,39 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package. + +## Enumeration Members + +### BodyParserNotPermitted + +```ts +BodyParserNotPermitted: "SLACKADAPTER_BODY_PARSER_NOT_PERMITTED_FAILURE"; +``` + +#### Defined in + +[packages/events-api/src/http-handler.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L17) + +*** + +### RequestTimeFailure + +```ts +RequestTimeFailure: "SLACKHTTPHANDLER_REQUEST_TIMELIMIT_FAILURE"; +``` + +#### Defined in + +[packages/events-api/src/http-handler.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L16) + +*** + +### SignatureVerificationFailure + +```ts +SignatureVerificationFailure: "SLACKHTTPHANDLER_REQUEST_SIGNATURE_VERIFICATION_FAILURE"; +``` + +#### Defined in + +[packages/events-api/src/http-handler.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L15) diff --git a/docs/content/reference/events-api/functions/createEventAdapter.md b/docs/content/reference/events-api/functions/createEventAdapter.md new file mode 100644 index 000000000..1bc9c4629 --- /dev/null +++ b/docs/content/reference/events-api/functions/createEventAdapter.md @@ -0,0 +1,21 @@ +# Function: createEventAdapter() + +```ts +function createEventAdapter(signingSecret, options?): SlackEventAdapter +``` + +Creates a new [SlackEventAdapter](../classes/SlackEventAdapter.md). + +## Parameters + +• **signingSecret**: `string` + +• **options?**: [`EventAdapterOptions`](../interfaces/EventAdapterOptions.md) + +## Returns + +[`SlackEventAdapter`](../classes/SlackEventAdapter.md) + +## Defined in + +[packages/events-api/src/index.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/index.ts#L15) diff --git a/docs/content/reference/events-api/functions/verifyRequestSignature.md b/docs/content/reference/events-api/functions/verifyRequestSignature.md new file mode 100644 index 000000000..019ef6eb0 --- /dev/null +++ b/docs/content/reference/events-api/functions/verifyRequestSignature.md @@ -0,0 +1,28 @@ +# Function: verifyRequestSignature() + +```ts +function verifyRequestSignature(params): true +``` + +Verifies the signature of a request. Throws a [CodedError](../interfaces/CodedError.md) if the signature is invalid. + +## Parameters + +• **params**: [`VerifyRequestSignatureParams`](../interfaces/VerifyRequestSignatureParams.md) + +See [VerifyRequestSignatureParams](../interfaces/VerifyRequestSignatureParams.md). + +## Returns + +`true` + +`true` when the signature is valid. + +## Remarks + +See [Verifying requests from Slack](https://api.slack.com/docs/verifying-requests-from-slack#sdk_support) for more +information. + +## Defined in + +[packages/events-api/src/http-handler.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L38) diff --git a/docs/content/reference/events-api/index.md b/docs/content/reference/events-api/index.md new file mode 100644 index 000000000..fb3adeb77 --- /dev/null +++ b/docs/content/reference/events-api/index.md @@ -0,0 +1,24 @@ +# @slack/events-api + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) + +## Classes + +- [SlackEventAdapter](classes/SlackEventAdapter.md) + +## Interfaces + +- [CodedError](interfaces/CodedError.md) +- [EventAdapterOptions](interfaces/EventAdapterOptions.md) +- [VerifyRequestSignatureParams](interfaces/VerifyRequestSignatureParams.md) + +## Variables + +- [errorCodes](variables/errorCodes.md) + +## Functions + +- [createEventAdapter](functions/createEventAdapter.md) +- [verifyRequestSignature](functions/verifyRequestSignature.md) diff --git a/docs/content/reference/events-api/interfaces/CodedError.md b/docs/content/reference/events-api/interfaces/CodedError.md new file mode 100644 index 000000000..66c8bea0c --- /dev/null +++ b/docs/content/reference/events-api/interfaces/CodedError.md @@ -0,0 +1,71 @@ +# Interface: CodedError + +All errors produced by this package are regular +[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) objects with +an extra [`error`](CodedError.md#code) field. + +## Extends + +- `Error` + +## Properties + +### code + +```ts +code: ErrorCode; +``` + +What kind of error occurred. + +#### Defined in + +[packages/events-api/src/http-handler.ts:292](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L292) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/events-api/interfaces/EventAdapterOptions.md b/docs/content/reference/events-api/interfaces/EventAdapterOptions.md new file mode 100644 index 000000000..778106f8f --- /dev/null +++ b/docs/content/reference/events-api/interfaces/EventAdapterOptions.md @@ -0,0 +1,40 @@ +# Interface: EventAdapterOptions + +Options when constructing [SlackEventAdapter](../classes/SlackEventAdapter.md). See [SlackEventAdapter](../classes/SlackEventAdapter.md)'s fields for more information on +what each option does. + +## Properties + +### includeBody? + +```ts +optional includeBody: boolean; +``` + +#### Defined in + +[packages/events-api/src/adapter.ts:140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L140) + +*** + +### includeHeaders? + +```ts +optional includeHeaders: boolean; +``` + +#### Defined in + +[packages/events-api/src/adapter.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L141) + +*** + +### waitForResponse? + +```ts +optional waitForResponse: boolean; +``` + +#### Defined in + +[packages/events-api/src/adapter.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L142) diff --git a/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md b/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md new file mode 100644 index 000000000..486802b43 --- /dev/null +++ b/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md @@ -0,0 +1,59 @@ +# Interface: VerifyRequestSignatureParams + +Parameters for calling [verifyRequestSignature](../functions/verifyRequestSignature.md). + +## Properties + +### body + +```ts +body: string; +``` + +Full, raw body string. + +#### Defined in + +[packages/events-api/src/http-handler.ts:280](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L280) + +*** + +### requestSignature + +```ts +requestSignature: string; +``` + +Signature from the `X-Slack-Signature` header. + +#### Defined in + +[packages/events-api/src/http-handler.ts:270](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L270) + +*** + +### requestTimestamp + +```ts +requestTimestamp: number; +``` + +Timestamp from the `X-Slack-Request-Timestamp` header. + +#### Defined in + +[packages/events-api/src/http-handler.ts:275](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L275) + +*** + +### signingSecret + +```ts +signingSecret: string; +``` + +The signing secret used to verify request signature. + +#### Defined in + +[packages/events-api/src/http-handler.ts:265](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L265) diff --git a/docs/content/reference/events-api/typedoc-sidebar.cjs b/docs/content/reference/events-api/typedoc-sidebar.cjs new file mode 100644 index 000000000..e72347534 --- /dev/null +++ b/docs/content/reference/events-api/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/events-api/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/events-api/classes/SlackEventAdapter","label":"SlackEventAdapter"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/events-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/events-api/interfaces/EventAdapterOptions","label":"EventAdapterOptions"},{"type":"doc","id":"reference/events-api/interfaces/VerifyRequestSignatureParams","label":"VerifyRequestSignatureParams"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/events-api/variables/errorCodes","label":"errorCodes"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/events-api/functions/createEventAdapter","label":"createEventAdapter"},{"type":"doc","id":"reference/events-api/functions/verifyRequestSignature","label":"verifyRequestSignature"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/events-api/variables/errorCodes.md b/docs/content/reference/events-api/variables/errorCodes.md new file mode 100644 index 000000000..9bbd7a477 --- /dev/null +++ b/docs/content/reference/events-api/variables/errorCodes.md @@ -0,0 +1,29 @@ +# Variable: errorCodes + +```ts +const errorCodes: object; +``` + +## Type declaration + +### BODY\_PARSER\_NOT\_PERMITTED + +```ts +BODY_PARSER_NOT_PERMITTED: ErrorCode = ErrorCode.BodyParserNotPermitted; +``` + +### REQUEST\_TIME\_FAILURE + +```ts +REQUEST_TIME_FAILURE: ErrorCode = ErrorCode.RequestTimeFailure; +``` + +### SIGNATURE\_VERIFICATION\_FAILURE + +```ts +SIGNATURE_VERIFICATION_FAILURE: ErrorCode = ErrorCode.SignatureVerificationFailure; +``` + +## Defined in + +[packages/events-api/src/http-handler.ts:305](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L305) diff --git a/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md b/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md new file mode 100644 index 000000000..774e5f43c --- /dev/null +++ b/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md @@ -0,0 +1,382 @@ +# Class: SlackMessageAdapter + +An adapter for Slack's interactive message components such as buttons, menus, and dialogs. + +## Constructors + +### new SlackMessageAdapter() + +```ts +new SlackMessageAdapter(signingSecret, __namedParameters): SlackMessageAdapter +``` + +Create a message adapter. + +#### Parameters + +• **signingSecret**: `string` + +Slack app signing secret used to authenticate request + +• **\_\_namedParameters**: [`MessageAdapterOptions`](../interfaces/MessageAdapterOptions.md) = `{}` + +#### Returns + +[`SlackMessageAdapter`](SlackMessageAdapter.md) + +#### Defined in + +[adapter.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L154) + +## Properties + +### lateResponseFallbackEnabled + +```ts +lateResponseFallbackEnabled: boolean; +``` + +Whether or not promises that resolve after the syncResponseTimeout can fallback to a request for the response_url. +This only works in cases where the semantic meaning of the response and the response_url are the same. + +#### Defined in + +[adapter.ts:136](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L136) + +*** + +### signingSecret + +```ts +signingSecret: string; +``` + +Slack app signing secret used to authenticate request + +#### Defined in + +[adapter.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L124) + +*** + +### syncResponseTimeout + +```ts +syncResponseTimeout: number; +``` + +The number of milliseconds to wait before flushing a synchronous response to an incoming request and falling back +to an asynchronous response. + +#### Defined in + +[adapter.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L130) + +## Methods + +### action() + +```ts +action(matchingConstraints, callback): this +``` + +Add a handler for an interactive message action. + +Usually there's no need to be concerned with _how_ a message is sent to Slack, but the following table describes it +fully. + +**Action**|**Return `object`**|**Return `Promise`**|**Return `undefined`**|**Call `respond(message)`**|**Notes** +:-----:|:-----:|:-----:|:-----:|:-----:|:-----: +**Button Press**| Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | Create a new message instead of replacing using `replace_original: false` +**Menu Selection**| Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | Create a new message instead of replacing using `replace_original: false` +**Message Action** | Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | +**Dialog Submission**| Error list in response | Error list in response | Empty response | Message in request to `response_url` | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. Warning logged if a promise isn't completed before `syncResponseTimeout`. + +#### Parameters + +• **matchingConstraints**: `string` \| `RegExp` \| [`ActionConstraints`](../interfaces/ActionConstraints.md) + +the callback ID (as a string or RegExp) or an object describing the constraints to + match actions for the handler. + +• **callback**: [`ActionHandler`](../type-aliases/ActionHandler.md) + +the function to run when an action is matched + +#### Returns + +`this` + +this instance (for chaining) + +#### Defined in + +[adapter.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L284) + +*** + +### createServer() + +```ts +createServer(): Promise +``` + +Create a server that dispatches Slack's interactive message actions and menu requests to this message adapter +instance. Use this method if your application will handle starting the server. + +#### Returns + +`Promise`\<`Server`\> + +A promise that resolves to an instance of http.Server and will dispatch interactive message actions and + options requests to this message adapter instance. See + https://nodejs.org/dist/latest/docs/api/http.html#http_class_http_server + +#### Defined in + +[adapter.ts:197](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L197) + +*** + +### dispatch() + +```ts +dispatch(payload): undefined | Promise +``` + +**`Internal`** + +Dispatches the contents of an HTTP request to the registered handlers. + +#### Parameters + +• **payload**: `any` + +#### Returns + +`undefined` \| `Promise`\<[`DispatchResult`](../interfaces/DispatchResult.md)\> + +A promise of the response information (an object with status and content that is a JSON serializable + object or a string or undefined) for the request. An undefined return value indicates that the request was not + matched. + +#### Remarks + +This is an internal API not meant to be used by code depending on this package. + +#### Defined in + +[adapter.ts:424](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L424) + +*** + +### expressMiddleware() + +```ts +expressMiddleware(): RequestHandler +``` + +Create a middleware function that can be used to integrate with the `express` web framework in order for incoming +requests to be dispatched to this message adapter instance. + +#### Returns + +`RequestHandler` + +A middleware function (see http://expressjs.com/en/guide/using-middleware.html) + +#### Defined in + +[adapter.ts:248](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L248) + +*** + +### options() + +```ts +options(matchingConstraints, callback): this +``` + +Add a handler for an options request + +Usually there's no need to be concerned with _how_ a message is sent to Slack, but the +following table describes it fully + + |**Return `options`**|**Return `Promise`**|**Return `undefined`**|**Notes** +:-----:|:-----:|:-----:|:-----:|:-----: +**Options Request**| Options in response | Options in response | Empty response | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. If the request is from within a dialog, the `text` field is called `label`. + +#### Parameters + +• **matchingConstraints**: `string` \| `RegExp` \| [`OptionsConstraints`](../interfaces/OptionsConstraints.md) + +the callback ID (as a string or RegExp) or an object describing the constraints to + select options requests for the handler. + +• **callback**: [`OptionsHandler`](../type-aliases/OptionsHandler.md) + +the function to run when an options request is matched + +#### Returns + +`this` + +this instance (for chaining) + +#### Defined in + +[adapter.ts:342](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L342) + +*** + +### requestListener() + +```ts +requestListener(): RequestListener +``` + +Create a request listener function that handles HTTP requests, verifies requests and dispatches responses + +#### Returns + +`RequestListener` + +#### Defined in + +[adapter.ts:258](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L258) + +*** + +### shortcut() + +```ts +shortcut(matchingConstraints, callback): this +``` + +#### Parameters + +• **matchingConstraints**: `string` \| `RegExp` \| [`ShortcutConstraints`](../interfaces/ShortcutConstraints.md) + +• **callback**: [`ShortcutHandler`](../type-aliases/ShortcutHandler.md) + +#### Returns + +`this` + +#### Defined in + +[adapter.ts:308](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L308) + +*** + +### start() + +```ts +start(port): Promise +``` + +Start a built-in server that dispatches Slack's interactive message actions and menu requests to this message +adapter interface. + +#### Parameters + +• **port**: `number` + +#### Returns + +`Promise`\<`Server`\> + +A promise that resolves once the server is ready + +#### Defined in + +[adapter.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L208) + +*** + +### stop() + +```ts +stop(): Promise +``` + +Stop the previously started built-in server. + +#### Returns + +`Promise`\<`void`\> + +A promise that resolves once the server is cleaned up. + +#### Defined in + +[adapter.ts:223](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L223) + +*** + +### viewClosed() + +```ts +viewClosed(matchingConstraints, callback): this +``` + +Add a handler for view closed interaction. The handler should not return a value. + +#### Parameters + +• **matchingConstraints**: `string` \| `RegExp` \| [`ViewConstraints`](../interfaces/ViewConstraints.md) + +the callback ID (as a string or RegExp) or an object describing the constraints to + match view closed interactions for the handler. + +• **callback**: [`ViewClosedHandler`](../type-aliases/ViewClosedHandler.md) + +the function to run when an view closed interaction is matched + +#### Returns + +`this` + +this instance (for chaining) + +#### Defined in + +[adapter.ts:397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L397) + +*** + +### viewSubmission() + +```ts +viewSubmission(matchingConstraints, callback): this +``` + +Add a handler for view submission. + +The value returned from the `callback` determines the response sent back to Slack. The handler can return a plain +object with a `response_action` property to dismiss the modal, push a view into the modal, display validation +errors, or update the view. Alternatively, the handler can return a Promise for this kind of object, which resolves +before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, to perform the same response actions. If the +Promise resolves afterwards or `lateResponseFallbackEnabled: true` then the modal will be dismissed. If the handler +returns `undefined` the modal will be dismissed. + +#### Parameters + +• **matchingConstraints**: `string` \| `RegExp` \| [`ViewConstraints`](../interfaces/ViewConstraints.md) + +the callback ID (as a string or RegExp) or an object describing the constraints to + match view submissions for the handler. + +• **callback**: [`ViewSubmissionHandler`](../type-aliases/ViewSubmissionHandler.md) + +the function to run when an view submission is matched + +#### Returns + +`this` + +this instance (for chaining) + +#### Defined in + +[adapter.ts:375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L375) diff --git a/docs/content/reference/interactive-messages/enumerations/ErrorCode.md b/docs/content/reference/interactive-messages/enumerations/ErrorCode.md new file mode 100644 index 000000000..07423d486 --- /dev/null +++ b/docs/content/reference/interactive-messages/enumerations/ErrorCode.md @@ -0,0 +1,51 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package. + +## Enumeration Members + +### BodyParserNotPermitted + +```ts +BodyParserNotPermitted: "SLACKADAPTER_BODY_PARSER_NOT_PERMITTED_FAILURE"; +``` + +#### Defined in + +[errors.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L8) + +*** + +### PromiseTimeout + +```ts +PromiseTimeout: "SLACKMESSAGEUTIL_PROMISE_TIMEOUT"; +``` + +#### Defined in + +[errors.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L5) + +*** + +### RequestTimeFailure + +```ts +RequestTimeFailure: "SLACKHTTPHANDLER_REQUEST_TIMELIMIT_FAILURE"; +``` + +#### Defined in + +[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L7) + +*** + +### SignatureVerificationFailure + +```ts +SignatureVerificationFailure: "SLACKHTTPHANDLER_REQUEST_SIGNATURE_VERIFICATION_FAILURE"; +``` + +#### Defined in + +[errors.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L6) diff --git a/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md b/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md new file mode 100644 index 000000000..3eb8a4e74 --- /dev/null +++ b/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md @@ -0,0 +1,27 @@ +# Enumeration: ResponseStatus + +Some HTTP response statuses. + +## Enumeration Members + +### Failure + +```ts +Failure: 500; +``` + +#### Defined in + +[adapter.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L30) + +*** + +### Ok + +```ts +Ok: 200; +``` + +#### Defined in + +[adapter.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L29) diff --git a/docs/content/reference/interactive-messages/functions/createMessageAdapter.md b/docs/content/reference/interactive-messages/functions/createMessageAdapter.md new file mode 100644 index 000000000..3ad3a72f9 --- /dev/null +++ b/docs/content/reference/interactive-messages/functions/createMessageAdapter.md @@ -0,0 +1,21 @@ +# Function: createMessageAdapter() + +```ts +function createMessageAdapter(signingSecret, options?): SlackMessageAdapter +``` + +Factory method to create an instance of [SlackMessageAdapter](../classes/SlackMessageAdapter.md) + +## Parameters + +• **signingSecret**: `string` + +• **options?**: [`MessageAdapterOptions`](../interfaces/MessageAdapterOptions.md) + +## Returns + +[`SlackMessageAdapter`](../classes/SlackMessageAdapter.md) + +## Defined in + +[index.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/index.ts#L34) diff --git a/docs/content/reference/interactive-messages/index.md b/docs/content/reference/interactive-messages/index.md new file mode 100644 index 000000000..dae9dc091 --- /dev/null +++ b/docs/content/reference/interactive-messages/index.md @@ -0,0 +1,36 @@ +# @slack/interactive-messages + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) +- [ResponseStatus](enumerations/ResponseStatus.md) + +## Classes + +- [SlackMessageAdapter](classes/SlackMessageAdapter.md) + +## Interfaces + +- [ActionConstraints](interfaces/ActionConstraints.md) +- [DispatchResult](interfaces/DispatchResult.md) +- [MessageAdapterOptions](interfaces/MessageAdapterOptions.md) +- [OptionsConstraints](interfaces/OptionsConstraints.md) +- [ShortcutConstraints](interfaces/ShortcutConstraints.md) +- [ViewConstraints](interfaces/ViewConstraints.md) + +## Type Aliases + +- [ActionHandler](type-aliases/ActionHandler.md) +- [OptionsHandler](type-aliases/OptionsHandler.md) +- [Respond](type-aliases/Respond.md) +- [ShortcutHandler](type-aliases/ShortcutHandler.md) +- [ViewClosedHandler](type-aliases/ViewClosedHandler.md) +- [ViewSubmissionHandler](type-aliases/ViewSubmissionHandler.md) + +## Variables + +- [errorCodes](variables/errorCodes.md) + +## Functions + +- [createMessageAdapter](functions/createMessageAdapter.md) diff --git a/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md b/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md new file mode 100644 index 000000000..12fda911a --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md @@ -0,0 +1,75 @@ +# Interface: ActionConstraints + +Constraints on when to call an action handler. + +## Properties + +### actionId? + +```ts +optional actionId: string | RegExp; +``` + +A string or RegExp to match against the `action_id` + +#### Defined in + +[adapter.ts:693](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L693) + +*** + +### blockId? + +```ts +optional blockId: string | RegExp; +``` + +A string or RegExp to match against the `block_id` + +#### Defined in + +[adapter.ts:688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L688) + +*** + +### callbackId? + +```ts +optional callbackId: string | RegExp; +``` + +A string or RegExp to match against the `callback_id` + +#### Defined in + +[adapter.ts:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L683) + +*** + +### type? + +```ts +optional type: string; +``` + +Valid types include all +[actions block elements](https://api.slack.com/reference/messaging/interactive-components), +`select` only for menu selections, or `dialog_submission` only for dialog submissions + +#### Defined in + +[adapter.ts:700](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L700) + +*** + +### unfurl? + +```ts +optional unfurl: boolean; +``` + +When `true` only match actions from an unfurl + +#### Defined in + +[adapter.ts:705](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L705) diff --git a/docs/content/reference/interactive-messages/interfaces/DispatchResult.md b/docs/content/reference/interactive-messages/interfaces/DispatchResult.md new file mode 100644 index 000000000..448eddd3b --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/DispatchResult.md @@ -0,0 +1,27 @@ +# Interface: DispatchResult + +The result of a call to [SlackMessageAdapter#dispatch](../classes/SlackMessageAdapter.md#dispatch). + +## Properties + +### content? + +```ts +optional content: any; +``` + +#### Defined in + +[adapter.ts:664](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L664) + +*** + +### status + +```ts +status: ResponseStatus; +``` + +#### Defined in + +[adapter.ts:663](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L663) diff --git a/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md b/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md new file mode 100644 index 000000000..653099511 --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md @@ -0,0 +1,39 @@ +# Interface: MessageAdapterOptions + +Options for constructing [SlackMessageAdapter](../classes/SlackMessageAdapter.md). + +## Properties + +### agent? + +```ts +optional agent: any; +``` + +#### Defined in + +[adapter.ts:673](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L673) + +*** + +### lateResponseFallbackEnabled? + +```ts +optional lateResponseFallbackEnabled: boolean; +``` + +#### Defined in + +[adapter.ts:672](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L672) + +*** + +### syncResponseTimeout? + +```ts +optional syncResponseTimeout: number; +``` + +#### Defined in + +[adapter.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L671) diff --git a/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md b/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md new file mode 100644 index 000000000..72cbc73c1 --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md @@ -0,0 +1,59 @@ +# Interface: OptionsConstraints + +Constraints on when to call an options handler. + +## Properties + +### actionId? + +```ts +optional actionId: string | RegExp; +``` + +A string or RegExp to match against the `action_id` + +#### Defined in + +[adapter.ts:740](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L740) + +*** + +### blockId? + +```ts +optional blockId: string | RegExp; +``` + +A string or RegExp to match against the `block_id` + +#### Defined in + +[adapter.ts:735](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L735) + +*** + +### callbackId? + +```ts +optional callbackId: string | RegExp; +``` + +A string or RegExp to match against the `callback_id` + +#### Defined in + +[adapter.ts:730](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L730) + +*** + +### within + +```ts +within: "block_actions" | "interactive_message" | "dialog"; +``` + +The source of options request. + +#### Defined in + +[adapter.ts:745](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L745) diff --git a/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md b/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md new file mode 100644 index 000000000..c3350f8f9 --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md @@ -0,0 +1,31 @@ +# Interface: ShortcutConstraints + +Constraints on when to call an shortcut handler. + +## Properties + +### callbackId? + +```ts +optional callbackId: string | RegExp; +``` + +A string or RegExp to match against the `callback_id` + +#### Defined in + +[adapter.ts:715](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L715) + +*** + +### type? + +```ts +optional type: "shortcut"; +``` + +Valid type includes shortcut + +#### Defined in + +[adapter.ts:720](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L720) diff --git a/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md b/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md new file mode 100644 index 000000000..d77d752cc --- /dev/null +++ b/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md @@ -0,0 +1,45 @@ +# Interface: ViewConstraints + +Constraints on when to call a view submission or view closed handler. + +## Properties + +### callbackId? + +```ts +optional callbackId: string | RegExp; +``` + +A string or RegExp to match against the `callback_id` + +#### Defined in + +[adapter.ts:755](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L755) + +*** + +### externalId? + +```ts +optional externalId: string | RegExp; +``` + +A string to match against the `external_id` + +#### Defined in + +[adapter.ts:760](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L760) + +*** + +### viewId? + +```ts +optional viewId: string; +``` + +A string to match against the `view_id` + +#### Defined in + +[adapter.ts:765](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L765) diff --git a/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md b/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md new file mode 100644 index 000000000..734d733f1 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md @@ -0,0 +1,39 @@ +# Type Alias: ActionHandler() + +```ts +type ActionHandler: (payload, respond) => any | Promise | undefined; +``` + +## Parameters + +• **payload**: `any` + +an object describing the + [block actions](https://api.slack.com/messaging/interactivity/enabling#understanding-payloads) + [button press](https://api.slack.com/docs/message-buttons#responding_to_message_actions), + [menu selection](https://api.slack.com/docs/message-menus#request_url_response), or + [dialog submission](https://api.slack.com/dialogs#evaluating_submission_responses). + +• **respond**: [`Respond`](Respond.md) + +When the action is a button press or menu selection, this function is used to update the message + where the action occurred or create new messages in the same conversation. When the action is a dialog submission, + this function is used to create new messages in the conversation where the dialog was triggered. + +## Returns + +`any` \| `Promise`\<`any`\> \| `undefined` + +When the action is a button press or a menu selection, this object is a replacement + [message](https://api.slack.com/docs/interactive-message-field-guide#top-level_message_fields) for the message in + which the action occurred. It may also be a Promise for a message, and if so and the Promise takes longer than the + `syncResponseTimeout` to complete, the message is sent over the `response_url`. The message may also be a new + message in the same conversation by setting `replace_original: false`. When the action is a dialog submission, + this object is a list of [validation errors](https://api.slack.com/dialogs#input_validation). It may also be a + Promise for a list of validation errors, and if so and the Promise takes longer than the `syncResponseTimeout` to + complete, Slack will display an error to the user. If there is no return value, then button presses and menu + selections do not update the message and dialog submissions will validate and dismiss. + +## Defined in + +[adapter.ts:813](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L813) diff --git a/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md b/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md new file mode 100644 index 000000000..8371a2553 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md @@ -0,0 +1,28 @@ +# Type Alias: OptionsHandler() + +```ts +type OptionsHandler: (payload) => any | Promise | undefined; +``` + +## Parameters + +• **payload**: `any` + +an object describing + [the state of the menu](https://api.slack.com/docs/message-menus#options_load_url) + +## Returns + +`any` \| `Promise`\<`any`\> \| `undefined` + +an [options list](https://api.slack.com/docs/interactive-message-field-guide#option_fields) or + [option groups list](https://api.slack.com/docs/interactive-message-field-guide#option_groups). When the menu is + within an interactive message, (`within: 'interactive_message'`) the option keys are `text` and `value`. When the + menu is within a dialog (`within: 'dialog'`) the option keys are `label` and `value`. When the menu is within a + dialog (`within: 'block_actions'`) the option keys are a text block and `value`. This function may also return a + Promise either of these values. If a Promise is returned and it does not complete within 3 seconds, Slack will + display an error to the user. If there is no return value, then the user is shown an empty list of options. + +## Defined in + +[adapter.ts:835](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L835) diff --git a/docs/content/reference/interactive-messages/type-aliases/Respond.md b/docs/content/reference/interactive-messages/type-aliases/Respond.md new file mode 100644 index 000000000..7714ed892 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/Respond.md @@ -0,0 +1,23 @@ +# Type Alias: Respond() + +```ts +type Respond: (message) => Promise; +``` + +## Parameters + +• **message**: `any` + +a [message](https://api.slack.com/docs/interactive-message-field-guide#top-level_message_fields). + Dialog submissions do not allow `replace_original: false` on this message. + +## Returns + +`Promise`\<`unknown`\> + +there's no contract or interface for the resolution value, but this Promise will resolve when the HTTP + response from the `response_url` request is complete and reject when there is an error. + +## Defined in + +[adapter.ts:789](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L789) diff --git a/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md b/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md new file mode 100644 index 000000000..30d633ee4 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md @@ -0,0 +1,21 @@ +# Type Alias: ShortcutHandler() + +```ts +type ShortcutHandler: (payload) => any | Promise | undefined; +``` + +A handler function for global shortcuts. + +TODO: describe the payload and return values more specifically? + +## Parameters + +• **payload**: `any` + +## Returns + +`any` \| `Promise`\<`any`\> \| `undefined` + +## Defined in + +[adapter.ts:820](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L820) diff --git a/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md b/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md new file mode 100644 index 000000000..ff6a4d773 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md @@ -0,0 +1,21 @@ +# Type Alias: ViewClosedHandler() + +```ts +type ViewClosedHandler: (payload) => void; +``` + +A handler function for view closed requests. + +TODO: describe the payload and return values more specifically? + +## Parameters + +• **payload**: `any` + +## Returns + +`void` + +## Defined in + +[adapter.ts:849](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L849) diff --git a/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md b/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md new file mode 100644 index 000000000..dae70ee31 --- /dev/null +++ b/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md @@ -0,0 +1,21 @@ +# Type Alias: ViewSubmissionHandler() + +```ts +type ViewSubmissionHandler: (payload) => any | Promise | undefined; +``` + +A handler function for view submission requests. + +TODO: describe the payload and return values more specifically? + +## Parameters + +• **payload**: `any` + +## Returns + +`any` \| `Promise`\<`any`\> \| `undefined` + +## Defined in + +[adapter.ts:842](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L842) diff --git a/docs/content/reference/interactive-messages/typedoc-sidebar.cjs b/docs/content/reference/interactive-messages/typedoc-sidebar.cjs new file mode 100644 index 000000000..0fb80bc36 --- /dev/null +++ b/docs/content/reference/interactive-messages/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/interactive-messages/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/interactive-messages/enumerations/ResponseStatus","label":"ResponseStatus"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/interactive-messages/classes/SlackMessageAdapter","label":"SlackMessageAdapter"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/interactive-messages/interfaces/ActionConstraints","label":"ActionConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/DispatchResult","label":"DispatchResult"},{"type":"doc","id":"reference/interactive-messages/interfaces/MessageAdapterOptions","label":"MessageAdapterOptions"},{"type":"doc","id":"reference/interactive-messages/interfaces/OptionsConstraints","label":"OptionsConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/ShortcutConstraints","label":"ShortcutConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/ViewConstraints","label":"ViewConstraints"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/interactive-messages/type-aliases/ActionHandler","label":"ActionHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/OptionsHandler","label":"OptionsHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/Respond","label":"Respond"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ShortcutHandler","label":"ShortcutHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ViewClosedHandler","label":"ViewClosedHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ViewSubmissionHandler","label":"ViewSubmissionHandler"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/interactive-messages/variables/errorCodes","label":"errorCodes"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/interactive-messages/functions/createMessageAdapter","label":"createMessageAdapter"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/interactive-messages/variables/errorCodes.md b/docs/content/reference/interactive-messages/variables/errorCodes.md new file mode 100644 index 000000000..cddb80b45 --- /dev/null +++ b/docs/content/reference/interactive-messages/variables/errorCodes.md @@ -0,0 +1,19 @@ +# Variable: errorCodes + +```ts +const errorCodes: object; +``` + +Dictionary of error codes that may appear on errors emitted from this package's objects + +## Type declaration + +### BODY\_PARSER\_NOT\_PERMITTED + +```ts +readonly BODY_PARSER_NOT_PERMITTED: BodyParserNotPermitted = ErrorCode.BodyParserNotPermitted; +``` + +## Defined in + +[index.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/index.ts#L25) diff --git a/docs/content/reference/logger/classes/ConsoleLogger.md b/docs/content/reference/logger/classes/ConsoleLogger.md new file mode 100644 index 000000000..fecea0306 --- /dev/null +++ b/docs/content/reference/logger/classes/ConsoleLogger.md @@ -0,0 +1,201 @@ +# Class: ConsoleLogger + +Default logger which logs to stdout and stderr + +## Implements + +- [`Logger`](../interfaces/Logger.md) + +## Constructors + +### new ConsoleLogger() + +```ts +new ConsoleLogger(): ConsoleLogger +``` + +#### Returns + +[`ConsoleLogger`](ConsoleLogger.md) + +#### Defined in + +[index.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L90) + +## Methods + +### debug() + +```ts +debug(...msg): void +``` + +Log a debug message + +#### Parameters + +• ...**msg**: `any`[] + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug) + +#### Defined in + +[index.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L117) + +*** + +### error() + +```ts +error(...msg): void +``` + +Log an error message + +#### Parameters + +• ...**msg**: `any`[] + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error) + +#### Defined in + +[index.ts:147](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L147) + +*** + +### getLevel() + +```ts +getLevel(): LogLevel +``` + +Return the current LogLevel. + +#### Returns + +[`LogLevel`](../enumerations/LogLevel.md) + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`getLevel`](../interfaces/Logger.md#getlevel) + +#### Defined in + +[index.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L95) + +*** + +### info() + +```ts +info(...msg): void +``` + +Log an info message + +#### Parameters + +• ...**msg**: `any`[] + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info) + +#### Defined in + +[index.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L127) + +*** + +### setLevel() + +```ts +setLevel(level): void +``` + +Sets the instance's log level so that only messages which are equal or more severe are output to the console. + +#### Parameters + +• **level**: [`LogLevel`](../enumerations/LogLevel.md) + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`setLevel`](../interfaces/Logger.md#setlevel) + +#### Defined in + +[index.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L102) + +*** + +### setName() + +```ts +setName(name): void +``` + +Set the instance's name, which will appear on each log line before the message. + +#### Parameters + +• **name**: `string` + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`setName`](../interfaces/Logger.md#setname) + +#### Defined in + +[index.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L109) + +*** + +### warn() + +```ts +warn(...msg): void +``` + +Log a warning message + +#### Parameters + +• ...**msg**: `any`[] + +#### Returns + +`void` + +#### Implementation of + +[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn) + +#### Defined in + +[index.ts:137](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L137) diff --git a/docs/content/reference/logger/enumerations/LogLevel.md b/docs/content/reference/logger/enumerations/LogLevel.md new file mode 100644 index 000000000..69614a47c --- /dev/null +++ b/docs/content/reference/logger/enumerations/LogLevel.md @@ -0,0 +1,51 @@ +# Enumeration: LogLevel + +Severity levels for log entries + +## Enumeration Members + +### DEBUG + +```ts +DEBUG: "debug"; +``` + +#### Defined in + +[index.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L10) + +*** + +### ERROR + +```ts +ERROR: "error"; +``` + +#### Defined in + +[index.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L7) + +*** + +### INFO + +```ts +INFO: "info"; +``` + +#### Defined in + +[index.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L9) + +*** + +### WARN + +```ts +WARN: "warn"; +``` + +#### Defined in + +[index.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L8) diff --git a/docs/content/reference/logger/index.md b/docs/content/reference/logger/index.md new file mode 100644 index 000000000..aa5090552 --- /dev/null +++ b/docs/content/reference/logger/index.md @@ -0,0 +1,13 @@ +# @slack/logger + +## Enumerations + +- [LogLevel](enumerations/LogLevel.md) + +## Classes + +- [ConsoleLogger](classes/ConsoleLogger.md) + +## Interfaces + +- [Logger](interfaces/Logger.md) diff --git a/docs/content/reference/logger/interfaces/Logger.md b/docs/content/reference/logger/interfaces/Logger.md new file mode 100644 index 000000000..bc426ad6a --- /dev/null +++ b/docs/content/reference/logger/interfaces/Logger.md @@ -0,0 +1,167 @@ +# Interface: Logger + +Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). + +## Methods + +### debug() + +```ts +debug(...msg): void +``` + +Output debug message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +[index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L22) + +*** + +### error() + +```ts +error(...msg): void +``` + +Output error message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +[index.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L43) + +*** + +### getLevel() + +```ts +getLevel(): LogLevel +``` + +Return the current LogLevel. + +#### Returns + +[`LogLevel`](../enumerations/LogLevel.md) + +#### Defined in + +[index.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L55) + +*** + +### info() + +```ts +info(...msg): void +``` + +Output info message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +[index.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L29) + +*** + +### setLevel() + +```ts +setLevel(level): void +``` + +This disables all logging below the given level, so that after a log.setLevel("warn") call log.warn("something") +or log.error("something") will output messages, but log.info("something") will not. + +#### Parameters + +• **level**: [`LogLevel`](../enumerations/LogLevel.md) + +as a string, like 'error' (case-insensitive) + +#### Returns + +`void` + +#### Defined in + +[index.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L50) + +*** + +### setName() + +```ts +setName(name): void +``` + +This allows the instance to be named so that they can easily be filtered when many loggers are sending output +to the same destination. + +#### Parameters + +• **name**: `string` + +as a string, will be output with every log after the level + +#### Returns + +`void` + +#### Defined in + +[index.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L62) + +*** + +### warn() + +```ts +warn(...msg): void +``` + +Output warn message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +[index.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L36) diff --git a/docs/content/reference/logger/typedoc-sidebar.cjs b/docs/content/reference/logger/typedoc-sidebar.cjs new file mode 100644 index 000000000..be53408c9 --- /dev/null +++ b/docs/content/reference/logger/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/logger/enumerations/LogLevel","label":"LogLevel"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/logger/classes/ConsoleLogger","label":"ConsoleLogger"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/logger/interfaces/Logger","label":"Logger"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/oauth/classes/AuthorizationError.md b/docs/content/reference/oauth/classes/AuthorizationError.md new file mode 100644 index 000000000..75bb0549d --- /dev/null +++ b/docs/content/reference/oauth/classes/AuthorizationError.md @@ -0,0 +1,123 @@ +# Class: AuthorizationError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new AuthorizationError() + +```ts +new AuthorizationError(message, original?): AuthorizationError +``` + +#### Parameters + +• **message**: `string` + +• **original?**: `Error` + +#### Returns + +[`AuthorizationError`](AuthorizationError.md) + +#### Overrides + +`Error.constructor` + +#### Defined in + +[packages/oauth/src/errors.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L45) + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.AuthorizationError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L41) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### original + +```ts +original: undefined | Error; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L43) + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/ClearStateStore.md b/docs/content/reference/oauth/classes/ClearStateStore.md new file mode 100644 index 000000000..5297be143 --- /dev/null +++ b/docs/content/reference/oauth/classes/ClearStateStore.md @@ -0,0 +1,93 @@ +# Class: ClearStateStore + +Generates state parameter value in the OAuth flow. +While the state parameter value works for the CSRF protection purpose, +it can transfer the given InstallURLOptions value to the Redirect URL handler +(Redirect URL: the default path is "/slack/oauth_redirect") + +## Implements + +- [`StateStore`](../interfaces/StateStore.md) + +## Constructors + +### new ClearStateStore() + +```ts +new ClearStateStore(stateSecret, stateExpirationSeconds): ClearStateStore +``` + +#### Parameters + +• **stateSecret**: `string` + +• **stateExpirationSeconds**: `number` = `600` + +#### Returns + +[`ClearStateStore`](ClearStateStore.md) + +#### Defined in + +[packages/oauth/src/state-stores/clear-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L13) + +## Methods + +### generateStateParam() + +```ts +generateStateParam(installOptions, now): Promise +``` + +Generates a valid state parameter value, which can be decoded as a StateObj object +by the verifyStateParam() method. This value may be stored on the server-side with expiration. +The InstallProvider verifies if this value is set in the installer's browser session. + +#### Parameters + +• **installOptions**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +• **now**: `Date` + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +[`StateStore`](../interfaces/StateStore.md).[`generateStateParam`](../interfaces/StateStore.md#generatestateparam) + +#### Defined in + +[packages/oauth/src/state-stores/clear-state-store.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L21) + +*** + +### verifyStateParam() + +```ts +verifyStateParam(now, state): Promise +``` + +Verifies the given state string value by trying to decode the value and +build the passed InstallURLOptions object from the data. +This method verifies if the state value is not too old to detect replay attacks. +If the value is invalid, this method can throw InvalidStateError exception. + +#### Parameters + +• **now**: `Date` + +• **state**: `string` + +#### Returns + +`Promise`\<[`InstallURLOptions`](../interfaces/InstallURLOptions.md)\> + +#### Implementation of + +[`StateStore`](../interfaces/StateStore.md).[`verifyStateParam`](../interfaces/StateStore.md#verifystateparam) + +#### Defined in + +[packages/oauth/src/state-stores/clear-state-store.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L33) diff --git a/docs/content/reference/oauth/classes/FileInstallationStore.md b/docs/content/reference/oauth/classes/FileInstallationStore.md new file mode 100644 index 000000000..06ca6e1ae --- /dev/null +++ b/docs/content/reference/oauth/classes/FileInstallationStore.md @@ -0,0 +1,103 @@ +# Class: FileInstallationStore + +## Implements + +- [`InstallationStore`](../interfaces/InstallationStore.md) + +## Constructors + +### new FileInstallationStore() + +```ts +new FileInstallationStore(__namedParameters): FileInstallationStore +``` + +#### Parameters + +• **\_\_namedParameters**: `FileInstallationOptions` = `{}` + +#### Returns + +[`FileInstallationStore`](FileInstallationStore.md) + +#### Defined in + +[packages/oauth/src/installation-stores/file-store.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L19) + +## Methods + +### deleteInstallation() + +```ts +deleteInstallation(query, logger?): Promise +``` + +#### Parameters + +• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`deleteInstallation`](../interfaces/InstallationStore.md#deleteinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/file-store.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L97) + +*** + +### fetchInstallation() + +```ts +fetchInstallation(query, logger?): Promise> +``` + +#### Parameters + +• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<[`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`fetchInstallation`](../interfaces/InstallationStore.md#fetchinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/file-store.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L61) + +*** + +### storeInstallation() + +```ts +storeInstallation(installation, logger?): Promise +``` + +#### Parameters + +• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`storeInstallation`](../interfaces/InstallationStore.md#storeinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/file-store.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L28) diff --git a/docs/content/reference/oauth/classes/FileStateStore.md b/docs/content/reference/oauth/classes/FileStateStore.md new file mode 100644 index 000000000..26fbe747e --- /dev/null +++ b/docs/content/reference/oauth/classes/FileStateStore.md @@ -0,0 +1,91 @@ +# Class: FileStateStore + +Generates state parameter value in the OAuth flow. +While the state parameter value works for the CSRF protection purpose, +it can transfer the given InstallURLOptions value to the Redirect URL handler +(Redirect URL: the default path is "/slack/oauth_redirect") + +## Implements + +- [`StateStore`](../interfaces/StateStore.md) + +## Constructors + +### new FileStateStore() + +```ts +new FileStateStore(args): FileStateStore +``` + +#### Parameters + +• **args**: [`FileStateStoreArgs`](../interfaces/FileStateStoreArgs.md) + +#### Returns + +[`FileStateStore`](FileStateStore.md) + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L24) + +## Methods + +### generateStateParam() + +```ts +generateStateParam(installOptions, now): Promise +``` + +Generates a valid state parameter value, which can be decoded as a StateObj object +by the verifyStateParam() method. This value may be stored on the server-side with expiration. +The InstallProvider verifies if this value is set in the installer's browser session. + +#### Parameters + +• **installOptions**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +• **now**: `Date` + +#### Returns + +`Promise`\<`string`\> + +#### Implementation of + +[`StateStore`](../interfaces/StateStore.md).[`generateStateParam`](../interfaces/StateStore.md#generatestateparam) + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L34) + +*** + +### verifyStateParam() + +```ts +verifyStateParam(now, state): Promise +``` + +Verifies the given state string value by trying to decode the value and +build the passed InstallURLOptions object from the data. +This method verifies if the state value is not too old to detect replay attacks. +If the value is invalid, this method can throw InvalidStateError exception. + +#### Parameters + +• **now**: `Date` + +• **state**: `string` + +#### Returns + +`Promise`\<[`InstallURLOptions`](../interfaces/InstallURLOptions.md)\> + +#### Implementation of + +[`StateStore`](../interfaces/StateStore.md).[`verifyStateParam`](../interfaces/StateStore.md#verifystateparam) + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L48) diff --git a/docs/content/reference/oauth/classes/GenerateInstallUrlError.md b/docs/content/reference/oauth/classes/GenerateInstallUrlError.md new file mode 100644 index 000000000..dd635be81 --- /dev/null +++ b/docs/content/reference/oauth/classes/GenerateInstallUrlError.md @@ -0,0 +1,109 @@ +# Class: GenerateInstallUrlError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new GenerateInstallUrlError() + +```ts +new GenerateInstallUrlError(message?): GenerateInstallUrlError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`GenerateInstallUrlError`](GenerateInstallUrlError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.GenerateInstallUrlError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L23) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/InstallProvider.md b/docs/content/reference/oauth/classes/InstallProvider.md new file mode 100644 index 000000000..82e2aca4a --- /dev/null +++ b/docs/content/reference/oauth/classes/InstallProvider.md @@ -0,0 +1,169 @@ +# Class: InstallProvider + +InstallProvider Class. Refer to InsallProviderOptions interface for the details of constructor arguments. + +## Constructors + +### new InstallProvider() + +```ts +new InstallProvider(__namedParameters): InstallProvider +``` + +#### Parameters + +• **\_\_namedParameters**: [`InstallProviderOptions`](../interfaces/InstallProviderOptions.md) + +#### Returns + +[`InstallProvider`](InstallProvider.md) + +#### Defined in + +[packages/oauth/src/install-provider.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L87) + +## Properties + +### installationStore + +```ts +installationStore: InstallationStore; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L38) + +*** + +### stateStore? + +```ts +optional stateStore: StateStore; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L35) + +## Methods + +### authorize() + +```ts +authorize(source): Promise +``` + +Fetches data from the installationStore + +#### Parameters + +• **source**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> + +#### Returns + +`Promise`\<[`AuthorizeResult`](../interfaces/AuthorizeResult.md)\> + +#### Defined in + +[packages/oauth/src/install-provider.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L173) + +*** + +### generateInstallUrl() + +```ts +generateInstallUrl( + options, + stateVerification, +state?): Promise +``` + +Returns a URL that is suitable for including in an Add to Slack button +Uses stateStore to generate a value for the state query param. + +#### Parameters + +• **options**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +• **stateVerification**: `boolean` = `true` + +• **state?**: `string` + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/oauth/src/install-provider.ts:408](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L408) + +*** + +### handleCallback() + +```ts +handleCallback( + req, + res, + options?, +installOptions?): Promise +``` + +This method handles the incoming request to the callback URL. +It can be used as a RequestListener in almost any HTTP server +framework. + +Verifies the state using the stateStore, exchanges the grant in the +query params for an access token, and stores token and associated data +in the installationStore. + +#### Parameters + +• **req**: `IncomingMessage` + +• **res**: `ServerResponse` + +• **options?**: [`CallbackOptions`](../interfaces/CallbackOptions.md) + +• **installOptions?**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/install-provider.ts:478](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L478) + +*** + +### handleInstallPath() + +```ts +handleInstallPath( + req, + res, + options?, +installOptions?): Promise +``` + +Handles the install path (the default is /slack/install) requests from an app installer. + +#### Parameters + +• **req**: `IncomingMessage` + +• **res**: `ServerResponse` + +• **options?**: [`InstallPathOptions`](../interfaces/InstallPathOptions.md) + +• **installOptions?**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/install-provider.ts:324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L324) diff --git a/docs/content/reference/oauth/classes/InstallerInitializationError.md b/docs/content/reference/oauth/classes/InstallerInitializationError.md new file mode 100644 index 000000000..807b8df0e --- /dev/null +++ b/docs/content/reference/oauth/classes/InstallerInitializationError.md @@ -0,0 +1,109 @@ +# Class: InstallerInitializationError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new InstallerInitializationError() + +```ts +new InstallerInitializationError(message?): InstallerInitializationError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`InstallerInitializationError`](InstallerInitializationError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.InstallerInitializationError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L19) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/InvalidStateError.md b/docs/content/reference/oauth/classes/InvalidStateError.md new file mode 100644 index 000000000..b500bdccc --- /dev/null +++ b/docs/content/reference/oauth/classes/InvalidStateError.md @@ -0,0 +1,109 @@ +# Class: InvalidStateError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new InvalidStateError() + +```ts +new InvalidStateError(message?): InvalidStateError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`InvalidStateError`](InvalidStateError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.InvalidStateError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L29) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/MemoryInstallationStore.md b/docs/content/reference/oauth/classes/MemoryInstallationStore.md new file mode 100644 index 000000000..0c62aed68 --- /dev/null +++ b/docs/content/reference/oauth/classes/MemoryInstallationStore.md @@ -0,0 +1,107 @@ +# Class: MemoryInstallationStore + +## Implements + +- [`InstallationStore`](../interfaces/InstallationStore.md) + +## Constructors + +### new MemoryInstallationStore() + +```ts +new MemoryInstallationStore(): MemoryInstallationStore +``` + +#### Returns + +[`MemoryInstallationStore`](MemoryInstallationStore.md) + +## Properties + +### devDB + +```ts +devDB: DevDatabase = {}; +``` + +#### Defined in + +[packages/oauth/src/installation-stores/memory-store.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L12) + +## Methods + +### deleteInstallation() + +```ts +deleteInstallation(query, logger?): Promise +``` + +#### Parameters + +• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`deleteInstallation`](../interfaces/InstallationStore.md#deleteinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/memory-store.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L59) + +*** + +### fetchInstallation() + +```ts +fetchInstallation(query, logger?): Promise> +``` + +#### Parameters + +• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<[`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`fetchInstallation`](../interfaces/InstallationStore.md#fetchinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/memory-store.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L38) + +*** + +### storeInstallation() + +```ts +storeInstallation(installation, logger?): Promise +``` + +#### Parameters + +• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`InstallationStore`](../interfaces/InstallationStore.md).[`storeInstallation`](../interfaces/InstallationStore.md#storeinstallation) + +#### Defined in + +[packages/oauth/src/installation-stores/memory-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L14) diff --git a/docs/content/reference/oauth/classes/MissingCodeError.md b/docs/content/reference/oauth/classes/MissingCodeError.md new file mode 100644 index 000000000..62db97341 --- /dev/null +++ b/docs/content/reference/oauth/classes/MissingCodeError.md @@ -0,0 +1,109 @@ +# Class: MissingCodeError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new MissingCodeError() + +```ts +new MissingCodeError(message?): MissingCodeError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`MissingCodeError`](MissingCodeError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.MissingCodeError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L33) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/MissingStateError.md b/docs/content/reference/oauth/classes/MissingStateError.md new file mode 100644 index 000000000..cd31665b0 --- /dev/null +++ b/docs/content/reference/oauth/classes/MissingStateError.md @@ -0,0 +1,109 @@ +# Class: MissingStateError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new MissingStateError() + +```ts +new MissingStateError(message?): MissingStateError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`MissingStateError`](MissingStateError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.MissingStateError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L26) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/UnknownError.md b/docs/content/reference/oauth/classes/UnknownError.md new file mode 100644 index 000000000..5f4713005 --- /dev/null +++ b/docs/content/reference/oauth/classes/UnknownError.md @@ -0,0 +1,109 @@ +# Class: UnknownError + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### new UnknownError() + +```ts +new UnknownError(message?): UnknownError +``` + +#### Parameters + +• **message?**: `string` + +#### Returns + +[`UnknownError`](UnknownError.md) + +#### Inherited from + +`Error.constructor` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.UnknownError; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +#### Defined in + +[packages/oauth/src/errors.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L37) + +*** + +### message + +```ts +message: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/enumerations/ErrorCode.md b/docs/content/reference/oauth/enumerations/ErrorCode.md new file mode 100644 index 000000000..8d311035c --- /dev/null +++ b/docs/content/reference/oauth/enumerations/ErrorCode.md @@ -0,0 +1,87 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package. + +## Enumeration Members + +### AuthorizationError + +```ts +AuthorizationError: "slack_oauth_installer_authorization_error"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L10) + +*** + +### GenerateInstallUrlError + +```ts +GenerateInstallUrlError: "slack_oauth_generate_url_error"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L11) + +*** + +### InstallerInitializationError + +```ts +InstallerInitializationError: "slack_oauth_installer_initialization_error"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L9) + +*** + +### InvalidStateError + +```ts +InvalidStateError: "slack_oauth_invalid_state"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L13) + +*** + +### MissingCodeError + +```ts +MissingCodeError: "slack_oauth_missing_code"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L14) + +*** + +### MissingStateError + +```ts +MissingStateError: "slack_oauth_missing_state"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L12) + +*** + +### UnknownError + +```ts +UnknownError: "slack_oauth_unknown_error"; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L15) diff --git a/docs/content/reference/oauth/functions/defaultCallbackFailure.md b/docs/content/reference/oauth/functions/defaultCallbackFailure.md new file mode 100644 index 000000000..4e5c155cd --- /dev/null +++ b/docs/content/reference/oauth/functions/defaultCallbackFailure.md @@ -0,0 +1,27 @@ +# Function: defaultCallbackFailure() + +```ts +function defaultCallbackFailure( + error, + _options, + _req, + res): void +``` + +## Parameters + +• **error**: [`CodedError`](../interfaces/CodedError.md) + +• **\_options**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +• **\_req**: `IncomingMessage` + +• **res**: `ServerResponse` + +## Returns + +`void` + +## Defined in + +[packages/oauth/src/callback-options.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L128) diff --git a/docs/content/reference/oauth/functions/defaultCallbackSuccess.md b/docs/content/reference/oauth/functions/defaultCallbackSuccess.md new file mode 100644 index 000000000..7b2d8c651 --- /dev/null +++ b/docs/content/reference/oauth/functions/defaultCallbackSuccess.md @@ -0,0 +1,27 @@ +# Function: defaultCallbackSuccess() + +```ts +function defaultCallbackSuccess( + installation, + _options, + _req, + res): void +``` + +## Parameters + +• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> + +• **\_options**: `undefined` \| [`InstallURLOptions`](../interfaces/InstallURLOptions.md) + +• **\_req**: `IncomingMessage` + +• **res**: `ServerResponse` + +## Returns + +`void` + +## Defined in + +[packages/oauth/src/callback-options.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L82) diff --git a/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md b/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md new file mode 100644 index 000000000..fafe8097f --- /dev/null +++ b/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md @@ -0,0 +1,17 @@ +# Function: defaultRenderHtmlForInstallPath() + +```ts +function defaultRenderHtmlForInstallPath(addToSlackUrl): string +``` + +## Parameters + +• **addToSlackUrl**: `string` + +## Returns + +`string` + +## Defined in + +[packages/oauth/src/default-render-html-for-install-path.ts:1](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/default-render-html-for-install-path.ts#L1) diff --git a/docs/content/reference/oauth/index.md b/docs/content/reference/oauth/index.md new file mode 100644 index 000000000..e73b1f689 --- /dev/null +++ b/docs/content/reference/oauth/index.md @@ -0,0 +1,58 @@ +# @slack/oauth + +## References + +### LogLevel + +Renames and re-exports [Logger](variables/Logger.md) + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) + +## Classes + +- [AuthorizationError](classes/AuthorizationError.md) +- [ClearStateStore](classes/ClearStateStore.md) +- [FileInstallationStore](classes/FileInstallationStore.md) +- [FileStateStore](classes/FileStateStore.md) +- [GenerateInstallUrlError](classes/GenerateInstallUrlError.md) +- [InstallProvider](classes/InstallProvider.md) +- [InstallerInitializationError](classes/InstallerInitializationError.md) +- [InvalidStateError](classes/InvalidStateError.md) +- [MemoryInstallationStore](classes/MemoryInstallationStore.md) +- [MissingCodeError](classes/MissingCodeError.md) +- [MissingStateError](classes/MissingStateError.md) +- [UnknownError](classes/UnknownError.md) + +## Interfaces + +- [AuthorizeResult](interfaces/AuthorizeResult.md) +- [CallbackOptions](interfaces/CallbackOptions.md) +- [CodedError](interfaces/CodedError.md) +- [FileStateStoreArgs](interfaces/FileStateStoreArgs.md) +- [InstallPathOptions](interfaces/InstallPathOptions.md) +- [InstallProviderOptions](interfaces/InstallProviderOptions.md) +- [InstallURLOptions](interfaces/InstallURLOptions.md) +- [Installation](interfaces/Installation.md) +- [InstallationQuery](interfaces/InstallationQuery.md) +- [InstallationStore](interfaces/InstallationStore.md) +- [OAuthV2Response](interfaces/OAuthV2Response.md) +- [OAuthV2TokenRefreshResponse](interfaces/OAuthV2TokenRefreshResponse.md) +- [StateObj](interfaces/StateObj.md) +- [StateStore](interfaces/StateStore.md) + +## Type Aliases + +- [OrgInstallation](type-aliases/OrgInstallation.md) +- [OrgInstallationQuery](type-aliases/OrgInstallationQuery.md) + +## Variables + +- [Logger](variables/Logger.md) + +## Functions + +- [defaultCallbackFailure](functions/defaultCallbackFailure.md) +- [defaultCallbackSuccess](functions/defaultCallbackSuccess.md) +- [defaultRenderHtmlForInstallPath](functions/defaultRenderHtmlForInstallPath.md) diff --git a/docs/content/reference/oauth/interfaces/AuthorizeResult.md b/docs/content/reference/oauth/interfaces/AuthorizeResult.md new file mode 100644 index 000000000..0b3c2be29 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/AuthorizeResult.md @@ -0,0 +1,121 @@ +# Interface: AuthorizeResult + +## Properties + +### botId? + +```ts +optional botId: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L11) + +*** + +### botRefreshToken? + +```ts +optional botRefreshToken: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L6) + +*** + +### botToken? + +```ts +optional botToken: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L5) + +*** + +### botTokenExpiresAt? + +```ts +optional botTokenExpiresAt: number; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L7) + +*** + +### botUserId? + +```ts +optional botUserId: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L12) + +*** + +### enterpriseId? + +```ts +optional enterpriseId: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L14) + +*** + +### teamId? + +```ts +optional teamId: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L13) + +*** + +### userRefreshToken? + +```ts +optional userRefreshToken: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L9) + +*** + +### userToken? + +```ts +optional userToken: string; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L8) + +*** + +### userTokenExpiresAt? + +```ts +optional userTokenExpiresAt: number; +``` + +#### Defined in + +[packages/oauth/src/authorize-result.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L10) diff --git a/docs/content/reference/oauth/interfaces/CallbackOptions.md b/docs/content/reference/oauth/interfaces/CallbackOptions.md new file mode 100644 index 000000000..24347058a --- /dev/null +++ b/docs/content/reference/oauth/interfaces/CallbackOptions.md @@ -0,0 +1,172 @@ +# Interface: CallbackOptions + +## Properties + +### afterInstallation()? + +```ts +optional afterInstallation: (installation, options, callbackReq, callbackRes) => Promise; +``` + +An additional logic to run right after executing the Slack app installation with the given OAuth code parameter. + +When this method returns false, the InstallProvider skips storing the installation in database. +You can set false when your app needs to cancel the installation (you can call auth.revoke API method for it) +and then, the app needs to display an error page to the installing user. + +Also, when returning false, this method is responsible to call callbackRes#end() method +to build complete HTTP response for end-users. + +#### Parameters + +• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[packages/oauth/src/callback-options.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L34) + +*** + +### beforeInstallation()? + +```ts +optional beforeInstallation: (options, callbackReq, callbackRes) => Promise; +``` + +An additional logic to run right before executing the Slack app installation with the given OAuth code parameter. + +When this method returns false, the InstallProvider skips the installation. +You can set false when the visiting user is not eligible to proceed with the Slack app installation flow. + +Also, when returning false, this method is responsible for calling the callbackRes#end() method +to build a complete HTTP response for end-users. + +#### Parameters + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[packages/oauth/src/callback-options.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L18) + +*** + +### failure()? + +```ts +optional failure: (error, options, callbackReq, callbackRes) => void; +``` + +#### Parameters + +• **error**: [`CodedError`](CodedError.md) + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`void` + +#### Defined in + +[packages/oauth/src/callback-options.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L64) + +*** + +### failureAsync()? + +```ts +optional failureAsync: (error, options, callbackReq, callbackRes) => Promise; +``` + +#### Parameters + +• **error**: [`CodedError`](CodedError.md) + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/callback-options.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L73) + +*** + +### success()? + +```ts +optional success: (installation, options, callbackReq, callbackRes) => void; +``` + +#### Parameters + +• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`void` + +#### Defined in + +[packages/oauth/src/callback-options.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L44) + +*** + +### successAsync()? + +```ts +optional successAsync: (installation, options, callbackReq, callbackRes) => Promise; +``` + +#### Parameters + +• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) + +• **options**: [`InstallURLOptions`](InstallURLOptions.md) + +• **callbackReq**: `IncomingMessage` + +• **callbackRes**: `ServerResponse` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/callback-options.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L53) diff --git a/docs/content/reference/oauth/interfaces/CodedError.md b/docs/content/reference/oauth/interfaces/CodedError.md new file mode 100644 index 000000000..6925db6b3 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/CodedError.md @@ -0,0 +1,65 @@ +# Interface: CodedError + +## Extends + +- `Error` + +## Properties + +### code + +```ts +code: string; +``` + +#### Defined in + +[packages/oauth/src/errors.ts:2](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L2) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`Error.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`Error.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`Error.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md b/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md new file mode 100644 index 000000000..181ddc4a4 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md @@ -0,0 +1,37 @@ +# Interface: FileStateStoreArgs + +## Properties + +### baseDir? + +```ts +optional baseDir: string; +``` + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L13) + +*** + +### logger? + +```ts +optional logger: any; +``` + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L14) + +*** + +### stateExpirationSeconds? + +```ts +optional stateExpirationSeconds: number; +``` + +#### Defined in + +[packages/oauth/src/state-stores/file-state-store.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L12) diff --git a/docs/content/reference/oauth/interfaces/InstallPathOptions.md b/docs/content/reference/oauth/interfaces/InstallPathOptions.md new file mode 100644 index 000000000..d9e5b8959 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/InstallPathOptions.md @@ -0,0 +1,38 @@ +# Interface: InstallPathOptions + +Customizable callbacks that are supposed to be called +inside InstallProvider#handleInstallPath() method. + +## Properties + +### beforeRedirection()? + +```ts +optional beforeRedirection: (request, response, options?) => Promise; +``` + +Customize the response headers and body data for +additional user-specific data handling such as acccount mapping and activity tracking. + +When this method returns false, the InstallProvider skips +the following operations including the redirection to Slack authorize URL. +You can set false when the visiting user is not eligible to proceed with the Slack app installation flow. + +Also, when returning false, this method is responsible for calling the response#end() method +to build a complete HTTP response for end-users. + +#### Parameters + +• **request**: `IncomingMessage` + +• **response**: `ServerResponse` + +• **options?**: [`InstallURLOptions`](InstallURLOptions.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Defined in + +[packages/oauth/src/install-path-options.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-path-options.ts#L22) diff --git a/docs/content/reference/oauth/interfaces/InstallProviderOptions.md b/docs/content/reference/oauth/interfaces/InstallProviderOptions.md new file mode 100644 index 000000000..81b5689b0 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/InstallProviderOptions.md @@ -0,0 +1,253 @@ +# Interface: InstallProviderOptions + +## Properties + +### authVersion? + +```ts +optional authVersion: "v1" | "v2"; +``` + +The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps"). +More details here: +- https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3 +- https://api.slack.com/authentication/migration + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L79) + +*** + +### authorizationUrl? + +```ts +optional authorizationUrl: string; +``` + +The slack.com authorize URL + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L28) + +*** + +### clientId + +```ts +clientId: string; +``` + +Client ID, which can be found under the Basic Information section of your application on https://api.slack.com/apps + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L13) + +*** + +### clientOptions? + +```ts +optional clientOptions: Omit; +``` + +The customization options for WebClient + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L99) + +*** + +### clientSecret + +```ts +clientSecret: string; +``` + +Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L18) + +*** + +### directInstall? + +```ts +optional directInstall: boolean; +``` + +The install path web page rendering will be skipped if true (default: false) + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L71) + +*** + +### installUrlOptions? + +```ts +optional installUrlOptions: InstallURLOptions; +``` + +The initialization options for the OAuth flow + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L84) + +*** + +### installationStore? + +```ts +optional installationStore: InstallationStore; +``` + +Manages installation data, which can be called by both the OAuth flow and authorize() in event handling + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L23) + +*** + +### legacyStateVerification? + +```ts +optional legacyStateVerification: boolean; +``` + +handleCallback() skips checking browser cookies if true (default: false) +Enabling this option is not recommended. +This is supposed to be used only for backward-compatibility with v2.4 and olders. + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L51) + +*** + +### logLevel? + +```ts +optional logLevel: any; +``` + +@slack/logger logging level used in this class + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L94) + +*** + +### logger? + +```ts +optional logger: any; +``` + +@slack/logger logging used in this class + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L89) + +*** + +### renderHtmlForInstallPath()? + +```ts +optional renderHtmlForInstallPath: (url) => string; +``` + +The function for rendering the web page for the install path URL + +#### Parameters + +• **url**: `string` + +#### Returns + +`string` + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L66) + +*** + +### stateCookieExpirationSeconds? + +```ts +optional stateCookieExpirationSeconds: number; +``` + +The expiration time in seconds for the state parameter value stored via cookies + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L61) + +*** + +### stateCookieName? + +```ts +optional stateCookieName: string; +``` + +The cookie name used for setting state parameter value in cookies + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L56) + +*** + +### stateSecret? + +```ts +optional stateSecret: string; +``` + +The secret value used for generating the state parameter value + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L39) + +*** + +### stateStore? + +```ts +optional stateStore: StateStore; +``` + +Stores state issued to authorization server +and verifies the value returned at redirection during OAuth flow to prevent CSRF + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L34) + +*** + +### stateVerification? + +```ts +optional stateVerification: boolean; +``` + +handleCallback() verifies the state parameter if true (default: true) + +#### Defined in + +[packages/oauth/src/install-provider-options.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L44) diff --git a/docs/content/reference/oauth/interfaces/InstallURLOptions.md b/docs/content/reference/oauth/interfaces/InstallURLOptions.md new file mode 100644 index 000000000..0a6cb1838 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/InstallURLOptions.md @@ -0,0 +1,61 @@ +# Interface: InstallURLOptions + +## Properties + +### metadata? + +```ts +optional metadata: string; +``` + +#### Defined in + +[packages/oauth/src/install-url-options.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L6) + +*** + +### redirectUri? + +```ts +optional redirectUri: string; +``` + +#### Defined in + +[packages/oauth/src/install-url-options.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L4) + +*** + +### scopes + +```ts +scopes: string | string[]; +``` + +#### Defined in + +[packages/oauth/src/install-url-options.ts:2](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L2) + +*** + +### teamId? + +```ts +optional teamId: string; +``` + +#### Defined in + +[packages/oauth/src/install-url-options.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L3) + +*** + +### userScopes? + +```ts +optional userScopes: string | string[]; +``` + +#### Defined in + +[packages/oauth/src/install-url-options.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L5) diff --git a/docs/content/reference/oauth/interfaces/Installation.md b/docs/content/reference/oauth/interfaces/Installation.md new file mode 100644 index 000000000..bc6c69d95 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/Installation.md @@ -0,0 +1,283 @@ +# Interface: Installation\ + +An individual installation of the Slack app. + +This interface creates a representation for installations that normalizes the responses from OAuth grant exchanges +across auth versions (responses from the Web API methods `oauth.v2.access` and `oauth.access`). It describes some of +these differences using the `AuthVersion` generic placeholder type. + +This interface also represents both installations which occur on individual Slack workspaces and on Slack enterprise +organizations. The `IsEnterpriseInstall` generic placeholder type is used to describe some of those differences. + +This representation is designed to be used both when producing data that should be stored by an InstallationStore, +and when consuming data that is fetched from an InstallationStore. Most often, InstallationStore implementations +are a database. If you are going to implement an InstallationStore, it's advised that you **store as much of the +data in these objects as possible so that you can return as much as possible inside `fetchInstallation()`**. + +A few properties are synthesized with a default value if they are not present when returned from +`fetchInstallation()`. These properties are optional in the interface so that stored installations from previous +versions of this library (from before those properties were introduced) continue to work without requiring a breaking +change. However the synthesized default values are not always perfect and are based on some assumptions, so this is +why it's recommended to store as much of that data as possible in any InstallationStore. + +Some of the properties (e.g. `team.name`) can change between when the installation occurred and when it is fetched +from the InstallationStore. This can be seen as a reason not to store those properties. In most workspaces these +properties rarely change, and for most Slack apps having a slightly out of date value has no impact. However if your +app uses these values in a way where it must be up to date, it's recommended to implement a caching strategy in the +InstallationStore to fetch the latest data from the Web API (using methods such as `auth.test`, `teams.info`, etc.) +as often as it makes sense for your Slack app. + +TODO: IsEnterpriseInstall is always false when AuthVersion is v1 + +## Type Parameters + +• **AuthVersion** *extends* `"v1"` \| `"v2"` = `"v1"` \| `"v2"` + +• **IsEnterpriseInstall** *extends* `boolean` = `boolean` + +## Properties + +### appId? + +```ts +optional appId: AuthVersion extends "v2" ? string : undefined; +``` + +The App ID, which does not vary per installation. Left as undefined when not returned from fetch. + +#### Defined in + +[packages/oauth/src/installation.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L76) + +*** + +### authVersion? + +```ts +optional authVersion: AuthVersion; +``` + +The version of Slack's auth flow that produced this installation. Synthesized as `v2` when not present. + +#### Defined in + +[packages/oauth/src/installation.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L91) + +*** + +### bot? + +```ts +optional bot: object; +``` + +#### expiresAt? + +```ts +optional expiresAt: number; +``` + +#### id + +```ts +id: string; +``` + +#### refreshToken? + +```ts +optional refreshToken: string; +``` + +#### scopes + +```ts +scopes: string[]; +``` + +#### token + +```ts +token: string; +``` + +#### userId + +```ts +userId: string; +``` + +#### Defined in + +[packages/oauth/src/installation.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L57) + +*** + +### enterprise + +```ts +enterprise: IsEnterpriseInstall extends true ? EnterpriseInfo : undefined | EnterpriseInfo; +``` + +When the installation is an enterprise install or when the installation occurs on the org to acquire `admin` scope, +the name and ID of the enterprise org. + +#### Defined in + +[packages/oauth/src/installation.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L47) + +*** + +### enterpriseUrl? + +```ts +optional enterpriseUrl: AuthVersion extends "v2" ? string : undefined; +``` + +When the installation is an enterprise org install, the URL of the landing page for all workspaces in the org. +Left as undefined when not returned from fetch. + +#### Defined in + +[packages/oauth/src/installation.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L85) + +*** + +### incomingWebhook? + +```ts +optional incomingWebhook: object; +``` + +#### channel? + +```ts +optional channel: string; +``` + +Left as undefined when not returned from fetch. + +#### channelId? + +```ts +optional channelId: string; +``` + +Left as undefined when not returned from fetch. + +#### configurationUrl? + +```ts +optional configurationUrl: string; +``` + +Left as undefined when not returned from fetch. + +#### url + +```ts +url: string; +``` + +#### Defined in + +[packages/oauth/src/installation.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L65) + +*** + +### isEnterpriseInstall? + +```ts +optional isEnterpriseInstall: IsEnterpriseInstall; +``` + +Whether the installation was performed on an enterprise org. Synthesized as `false` when not present. + +#### Defined in + +[packages/oauth/src/installation.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L88) + +*** + +### metadata? + +```ts +optional metadata: string; +``` + +A string value that can be held in the state parameter in the OAuth flow. + +#### Defined in + +[packages/oauth/src/installation.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L94) + +*** + +### team + +```ts +team: IsEnterpriseInstall extends true ? undefined : object; +``` + +TODO: when performing a “single workspace” install with the admin scope on the enterprise, +is the team property returned from oauth.access? + +#### Defined in + +[packages/oauth/src/installation.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L37) + +*** + +### tokenType? + +```ts +optional tokenType: "bot"; +``` + +When the installation contains a bot user, the token type. Left as undefined when not returned from fetch. + +#### Defined in + +[packages/oauth/src/installation.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L79) + +*** + +### user + +```ts +user: object; +``` + +#### expiresAt? + +```ts +optional expiresAt: AuthVersion extends "v1" ? never : undefined | number; +``` + +#### id + +```ts +id: string; +``` + +#### refreshToken? + +```ts +optional refreshToken: AuthVersion extends "v1" ? never : undefined | string; +``` + +#### scopes + +```ts +scopes: AuthVersion extends "v1" ? string[] : undefined | string[]; +``` + +#### token + +```ts +token: AuthVersion extends "v1" ? string : undefined | string; +``` + +#### Defined in + +[packages/oauth/src/installation.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L49) diff --git a/docs/content/reference/oauth/interfaces/InstallationQuery.md b/docs/content/reference/oauth/interfaces/InstallationQuery.md new file mode 100644 index 000000000..9db8d8fd7 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/InstallationQuery.md @@ -0,0 +1,65 @@ +# Interface: InstallationQuery\ + +## Type Parameters + +• **isEnterpriseInstall** *extends* `boolean` + +## Properties + +### conversationId? + +```ts +optional conversationId: string; +``` + +#### Defined in + +[packages/oauth/src/installation-query.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L8) + +*** + +### enterpriseId + +```ts +enterpriseId: isEnterpriseInstall extends true ? string : undefined | string; +``` + +#### Defined in + +[packages/oauth/src/installation-query.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L6) + +*** + +### isEnterpriseInstall + +```ts +isEnterpriseInstall: isEnterpriseInstall; +``` + +#### Defined in + +[packages/oauth/src/installation-query.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L4) + +*** + +### teamId + +```ts +teamId: isEnterpriseInstall extends false ? string : undefined; +``` + +#### Defined in + +[packages/oauth/src/installation-query.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L5) + +*** + +### userId? + +```ts +optional userId: string; +``` + +#### Defined in + +[packages/oauth/src/installation-query.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L7) diff --git a/docs/content/reference/oauth/interfaces/InstallationStore.md b/docs/content/reference/oauth/interfaces/InstallationStore.md new file mode 100644 index 000000000..901aab173 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/InstallationStore.md @@ -0,0 +1,71 @@ +# Interface: InstallationStore + +## Properties + +### deleteInstallation()? + +```ts +optional deleteInstallation: (query, logger?) => Promise; +``` + +#### Parameters + +• **query**: [`InstallationQuery`](InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/installation-stores/interface.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L14) + +*** + +### fetchInstallation() + +```ts +fetchInstallation: (query, logger?) => Promise>; +``` + +#### Parameters + +• **query**: [`InstallationQuery`](InstallationQuery.md)\<`boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<[`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> + +#### Defined in + +[packages/oauth/src/installation-stores/interface.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L11) + +## Methods + +### storeInstallation() + +```ts +storeInstallation(installation, logger?): Promise +``` + +#### Type Parameters + +• **AuthVersion** *extends* `"v1"` \| `"v2"` + +#### Parameters + +• **installation**: [`Installation`](Installation.md)\<`AuthVersion`, `boolean`\> + +• **logger?**: `any` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/oauth/src/installation-stores/interface.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L7) diff --git a/docs/content/reference/oauth/interfaces/OAuthV2Response.md b/docs/content/reference/oauth/interfaces/OAuthV2Response.md new file mode 100644 index 000000000..7cfa2cc81 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/OAuthV2Response.md @@ -0,0 +1,209 @@ +# Interface: OAuthV2Response + +## Extends + +- [`Logger`](../variables/Logger.md) + +## Properties + +### access\_token? + +```ts +optional access_token: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:769](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L769) + +*** + +### app\_id + +```ts +app_id: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:758](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L758) + +*** + +### authed\_user + +```ts +authed_user: object; +``` + +#### access\_token? + +```ts +optional access_token: string; +``` + +#### expires\_in? + +```ts +optional expires_in: number; +``` + +#### id + +```ts +id: string; +``` + +#### refresh\_token? + +```ts +optional refresh_token: string; +``` + +#### scope? + +```ts +optional scope: string; +``` + +#### token\_type? + +```ts +optional token_type: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:759](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L759) + +*** + +### bot\_user\_id? + +```ts +optional bot_user_id: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:772](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L772) + +*** + +### enterprise + +```ts +enterprise: null | object; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:774](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L774) + +*** + +### expires\_in? + +```ts +optional expires_in: number; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:771](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L771) + +*** + +### incoming\_webhook? + +```ts +optional incoming_webhook: object; +``` + +#### channel + +```ts +channel: string; +``` + +#### channel\_id + +```ts +channel_id: string; +``` + +#### configuration\_url + +```ts +configuration_url: string; +``` + +#### url + +```ts +url: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:776](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L776) + +*** + +### is\_enterprise\_install + +```ts +is_enterprise_install: boolean; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:775](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L775) + +*** + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:770](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L770) + +*** + +### scope? + +```ts +optional scope: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L767) + +*** + +### team + +```ts +team: null | object; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:773](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L773) + +*** + +### token\_type? + +```ts +optional token_type: "bot"; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:768](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L768) diff --git a/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md b/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md new file mode 100644 index 000000000..d31fe31d5 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md @@ -0,0 +1,137 @@ +# Interface: OAuthV2TokenRefreshResponse + +## Extends + +- [`Logger`](../variables/Logger.md) + +## Properties + +### access\_token + +```ts +access_token: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:788](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L788) + +*** + +### app\_id + +```ts +app_id: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:785](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L785) + +*** + +### bot\_user\_id? + +```ts +optional bot_user_id: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L791) + +*** + +### enterprise + +```ts +enterprise: null | object; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:793](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L793) + +*** + +### expires\_in + +```ts +expires_in: number; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:790](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L790) + +*** + +### is\_enterprise\_install + +```ts +is_enterprise_install: boolean; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:794](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L794) + +*** + +### refresh\_token + +```ts +refresh_token: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:789](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L789) + +*** + +### scope + +```ts +scope: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:786](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L786) + +*** + +### team + +```ts +team: object; +``` + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:792](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L792) + +*** + +### token\_type + +```ts +token_type: "bot" | "user"; +``` + +#### Defined in + +[packages/oauth/src/install-provider.ts:787](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L787) diff --git a/docs/content/reference/oauth/interfaces/StateObj.md b/docs/content/reference/oauth/interfaces/StateObj.md new file mode 100644 index 000000000..750dcb299 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/StateObj.md @@ -0,0 +1,43 @@ +# Interface: StateObj + +The data structure represented by the state parameter. + +## Properties + +### installOptions + +```ts +installOptions: InstallURLOptions; +``` + +The passed InstallURLOptions object when generating this state parameter. + +#### Defined in + +[packages/oauth/src/state-stores/interface.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L16) + +*** + +### now + +```ts +now: Date; +``` + +The timestamp that the state object was generated. + +#### Defined in + +[packages/oauth/src/state-stores/interface.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L11) + +*** + +### random? + +```ts +optional random: string | number; +``` + +#### Defined in + +[packages/oauth/src/state-stores/interface.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L17) diff --git a/docs/content/reference/oauth/interfaces/StateStore.md b/docs/content/reference/oauth/interfaces/StateStore.md new file mode 100644 index 000000000..5fa3abc67 --- /dev/null +++ b/docs/content/reference/oauth/interfaces/StateStore.md @@ -0,0 +1,59 @@ +# Interface: StateStore + +Generates state parameter value in the OAuth flow. +While the state parameter value works for the CSRF protection purpose, +it can transfer the given InstallURLOptions value to the Redirect URL handler +(Redirect URL: the default path is "/slack/oauth_redirect") + +## Properties + +### generateStateParam() + +```ts +generateStateParam: (installOptions, now) => Promise; +``` + +Generates a valid state parameter value, which can be decoded as a StateObj object +by the verifyStateParam() method. This value may be stored on the server-side with expiration. +The InstallProvider verifies if this value is set in the installer's browser session. + +#### Parameters + +• **installOptions**: [`InstallURLOptions`](InstallURLOptions.md) + +• **now**: `Date` + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/oauth/src/state-stores/interface.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L33) + +*** + +### verifyStateParam() + +```ts +verifyStateParam: (now, state) => Promise; +``` + +Verifies the given state string value by trying to decode the value and +build the passed InstallURLOptions object from the data. +This method verifies if the state value is not too old to detect replay attacks. +If the value is invalid, this method can throw InvalidStateError exception. + +#### Parameters + +• **now**: `Date` + +• **state**: `string` + +#### Returns + +`Promise`\<[`InstallURLOptions`](InstallURLOptions.md)\> + +#### Defined in + +[packages/oauth/src/state-stores/interface.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L41) diff --git a/docs/content/reference/oauth/type-aliases/OrgInstallation.md b/docs/content/reference/oauth/type-aliases/OrgInstallation.md new file mode 100644 index 000000000..1746752df --- /dev/null +++ b/docs/content/reference/oauth/type-aliases/OrgInstallation.md @@ -0,0 +1,11 @@ +# Type Alias: OrgInstallation + +```ts +type OrgInstallation: Installation<"v2", true>; +``` + +A type to describe enterprise organization installations. + +## Defined in + +[packages/oauth/src/installation.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L100) diff --git a/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md b/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md new file mode 100644 index 000000000..596ba3b34 --- /dev/null +++ b/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md @@ -0,0 +1,9 @@ +# Type Alias: OrgInstallationQuery + +```ts +type OrgInstallationQuery: InstallationQuery; +``` + +## Defined in + +[packages/oauth/src/installation-query.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L12) diff --git a/docs/content/reference/oauth/typedoc-sidebar.cjs b/docs/content/reference/oauth/typedoc-sidebar.cjs new file mode 100644 index 000000000..f303649b9 --- /dev/null +++ b/docs/content/reference/oauth/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/oauth/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/oauth/classes/AuthorizationError","label":"AuthorizationError"},{"type":"doc","id":"reference/oauth/classes/ClearStateStore","label":"ClearStateStore"},{"type":"doc","id":"reference/oauth/classes/FileInstallationStore","label":"FileInstallationStore"},{"type":"doc","id":"reference/oauth/classes/FileStateStore","label":"FileStateStore"},{"type":"doc","id":"reference/oauth/classes/GenerateInstallUrlError","label":"GenerateInstallUrlError"},{"type":"doc","id":"reference/oauth/classes/InstallProvider","label":"InstallProvider"},{"type":"doc","id":"reference/oauth/classes/InstallerInitializationError","label":"InstallerInitializationError"},{"type":"doc","id":"reference/oauth/classes/InvalidStateError","label":"InvalidStateError"},{"type":"doc","id":"reference/oauth/classes/MemoryInstallationStore","label":"MemoryInstallationStore"},{"type":"doc","id":"reference/oauth/classes/MissingCodeError","label":"MissingCodeError"},{"type":"doc","id":"reference/oauth/classes/MissingStateError","label":"MissingStateError"},{"type":"doc","id":"reference/oauth/classes/UnknownError","label":"UnknownError"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/oauth/interfaces/AuthorizeResult","label":"AuthorizeResult"},{"type":"doc","id":"reference/oauth/interfaces/CallbackOptions","label":"CallbackOptions"},{"type":"doc","id":"reference/oauth/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/oauth/interfaces/FileStateStoreArgs","label":"FileStateStoreArgs"},{"type":"doc","id":"reference/oauth/interfaces/InstallPathOptions","label":"InstallPathOptions"},{"type":"doc","id":"reference/oauth/interfaces/InstallProviderOptions","label":"InstallProviderOptions"},{"type":"doc","id":"reference/oauth/interfaces/InstallURLOptions","label":"InstallURLOptions"},{"type":"doc","id":"reference/oauth/interfaces/Installation","label":"Installation"},{"type":"doc","id":"reference/oauth/interfaces/InstallationQuery","label":"InstallationQuery"},{"type":"doc","id":"reference/oauth/interfaces/InstallationStore","label":"InstallationStore"},{"type":"doc","id":"reference/oauth/interfaces/OAuthV2Response","label":"OAuthV2Response"},{"type":"doc","id":"reference/oauth/interfaces/OAuthV2TokenRefreshResponse","label":"OAuthV2TokenRefreshResponse"},{"type":"doc","id":"reference/oauth/interfaces/StateObj","label":"StateObj"},{"type":"doc","id":"reference/oauth/interfaces/StateStore","label":"StateStore"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/oauth/type-aliases/OrgInstallation","label":"OrgInstallation"},{"type":"doc","id":"reference/oauth/type-aliases/OrgInstallationQuery","label":"OrgInstallationQuery"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/oauth/variables/Logger","label":"Logger"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/oauth/functions/defaultCallbackFailure","label":"defaultCallbackFailure"},{"type":"doc","id":"reference/oauth/functions/defaultCallbackSuccess","label":"defaultCallbackSuccess"},{"type":"doc","id":"reference/oauth/functions/defaultRenderHtmlForInstallPath","label":"defaultRenderHtmlForInstallPath"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/oauth/variables/Logger.md b/docs/content/reference/oauth/variables/Logger.md new file mode 100644 index 000000000..e32c0b8c7 --- /dev/null +++ b/docs/content/reference/oauth/variables/Logger.md @@ -0,0 +1,5 @@ +# Variable: Logger + +```ts +Logger: any; +``` diff --git a/docs/content/reference/rtm-api/classes/RTMClient.md b/docs/content/reference/rtm-api/classes/RTMClient.md new file mode 100644 index 000000000..7a5da3ed5 --- /dev/null +++ b/docs/content/reference/rtm-api/classes/RTMClient.md @@ -0,0 +1,316 @@ +# Class: RTMClient + +An RTMClient allows programs to communicate with the [Platform's RTM API](https://api.slack.com/rtm|Slack). +This object uses the EventEmitter pattern to dispatch incoming events and has several methods for sending outgoing +messages. + +## Extends + +- [`Logger`](../variables/Logger.md) + +## Constructors + +### new RTMClient() + +```ts +new RTMClient(token, __namedParameters): RTMClient +``` + +#### Parameters + +• **token**: `string` + +• **\_\_namedParameters**: [`RTMClientOptions`](../interfaces/RTMClientOptions.md) = `{}` + +#### Returns + +[`RTMClient`](RTMClient.md) + +#### Overrides + +`EventEmitter.constructor` + +#### Defined in + +[RTMClient.ts:340](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L340) + +## Properties + +### activeTeamId? + +```ts +optional activeTeamId: string; +``` + +The team ID for the workspace the client is connected to. + +#### Defined in + +[RTMClient.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L83) + +*** + +### activeUserId? + +```ts +optional activeUserId: string; +``` + +The user ID for the connected client. + +#### Defined in + +[RTMClient.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L78) + +*** + +### authenticated + +```ts +authenticated: boolean = false; +``` + +Whether or not the client has authenticated to the RTM API. This occurs when the connect method +completes, and a WebSocket URL is available for the client's connection. + +#### Defined in + +[RTMClient.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L73) + +*** + +### connected + +```ts +connected: boolean = false; +``` + +Whether or not the client is currently connected to the RTM API + +#### Defined in + +[RTMClient.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L67) + +## Methods + +### addOutgoingEvent() + +#### addOutgoingEvent(awaitReply, type, body) + +```ts +addOutgoingEvent( + awaitReply, + type, +body?): Promise +``` + +Generic method for sending an outgoing message of an arbitrary type. This method guards the higher-level methods +from concern of which state the client is in, because it places all messages into a queue. The tasks on the queue +will buffer until the client is in a state where they can be sent. + +If the awaitReply parameter is set to true, then the returned Promise is resolved with the platform's +acknowledgement response. Not all message types will result in an acknowledgement response, so use this carefully. +This promise may be rejected with an error containing code=RTMNoReplyReceivedError if the client disconnects or +reconnects before receiving the acknowledgement response. + +If the awaitReply parameter is set to false, then the returned Promise is resolved as soon as the message is sent +from the websocket. + +##### Parameters + +• **awaitReply**: `true` + +whether to wait for an acknowledgement response from the platform before resolving the returned +Promise. + +• **type**: `string` + +the message type + +• **body?**: `Record`\<`string`, `unknown`\> + +the message body + +##### Returns + +`Promise`\<[`RTMCallResult`](../interfaces/RTMCallResult.md)\> + +##### Defined in + +[RTMClient.ts:493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L493) + +#### addOutgoingEvent(awaitReply, type, body) + +```ts +addOutgoingEvent( + awaitReply, + type, +body?): Promise +``` + +##### Parameters + +• **awaitReply**: `false` + +• **type**: `string` + +• **body?**: `Record`\<`string`, `unknown`\> + +##### Returns + +`Promise`\<`void`\> + +##### Defined in + +[RTMClient.ts:494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L494) + +*** + +### disconnect() + +```ts +disconnect(): Promise +``` + +End an RTM session. After this method is called no messages will be sent or received unless you call +start() again later. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[RTMClient.ts:432](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L432) + +*** + +### send() + +```ts +send(type, body): Promise +``` + +Generic method for sending an outgoing message of an arbitrary type. The main difference between this method and +addOutgoingEvent() is that this method does not use a queue so it can only be used while the client is ready +to send messages (in the 'ready' substate of the 'connected' state). It returns a Promise for the message ID of the +sent message. This is an internal ID and generally shouldn't be used as an identifier for messages (for that, +there is `ts` on messages once the server acknowledges it). + +#### Parameters + +• **type**: `string` + +the message type + +• **body** = `{}` + +the message body + +#### Returns + +`Promise`\<`number`\> + +#### Defined in + +[RTMClient.ts:541](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L541) + +*** + +### sendMessage() + +```ts +sendMessage(text, conversationId): Promise +``` + +Send a simple message to a public channel, private channel, DM, or MPDM. + +#### Parameters + +• **text**: `string` + +The message text. + +• **conversationId**: `string` + +A conversation ID for the destination of this message. + +#### Returns + +`Promise`\<[`RTMCallResult`](../interfaces/RTMCallResult.md)\> + +#### Defined in + +[RTMClient.ts:455](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L455) + +*** + +### sendTyping() + +```ts +sendTyping(conversationId): Promise +``` + +Sends a typing indicator to indicate that the user with `activeUserId` is typing. + +#### Parameters + +• **conversationId**: `string` + +The destination for where the typing indicator should be shown. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[RTMClient.ts:463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L463) + +*** + +### start() + +```ts +start(options?): Promise +``` + +Begin an RTM session using the provided options. This method must be called before any messages can +be sent or received. + +#### Parameters + +• **options?**: `any` + +#### Returns + +`Promise`\<`WebAPICallResult`\> + +#### Defined in + +[RTMClient.ts:406](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L406) + +*** + +### subscribePresence() + +```ts +subscribePresence(userIds): Promise +``` + +Subscribes this client to presence changes for only the given `userIds`. + +#### Parameters + +• **userIds**: `string`[] + +An array of user IDs whose presence you are interested in. This list will replace the list from +any previous calls to this method. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[RTMClient.ts:472](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L472) diff --git a/docs/content/reference/rtm-api/enumerations/ErrorCode.md b/docs/content/reference/rtm-api/enumerations/ErrorCode.md new file mode 100644 index 000000000..8d83347ba --- /dev/null +++ b/docs/content/reference/rtm-api/enumerations/ErrorCode.md @@ -0,0 +1,99 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package + +## Enumeration Members + +### KeepAliveClientNotConnected + +```ts +KeepAliveClientNotConnected: "slack_rtmapi_keepalive_client_not_connected"; +``` + +#### Defined in + +[errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L22) + +*** + +### KeepAliveConfigError + +```ts +KeepAliveConfigError: "slack_rtmapi_keepalive_config_error"; +``` + +#### Defined in + +[errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L21) + +*** + +### KeepAliveInconsistentState + +```ts +KeepAliveInconsistentState: "slack_rtmapi_keepalive_inconsistent_state"; +``` + +#### Defined in + +[errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L23) + +*** + +### NoReplyReceivedError + +```ts +NoReplyReceivedError: "slack_rtmapi_no_reply_received_error"; +``` + +#### Defined in + +[errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L18) + +*** + +### SendMessagePlatformError + +```ts +SendMessagePlatformError: "slack_rtmapi_send_message_platform_error"; +``` + +#### Defined in + +[errors.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L16) + +*** + +### SendWhileDisconnectedError + +```ts +SendWhileDisconnectedError: "slack_rtmapi_send_while_disconnected_error"; +``` + +#### Defined in + +[errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L14) + +*** + +### SendWhileNotReadyError + +```ts +SendWhileNotReadyError: "slack_rtmapi_send_while_not_ready_error"; +``` + +#### Defined in + +[errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L15) + +*** + +### WebsocketError + +```ts +WebsocketError: "slack_rtmapi_websocket_error"; +``` + +#### Defined in + +[errors.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L17) diff --git a/docs/content/reference/rtm-api/index.md b/docs/content/reference/rtm-api/index.md new file mode 100644 index 000000000..086fabe18 --- /dev/null +++ b/docs/content/reference/rtm-api/index.md @@ -0,0 +1,35 @@ +# @slack/rtm-api + +## References + +### LogLevel + +Renames and re-exports [Logger](variables/Logger.md) + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) + +## Classes + +- [RTMClient](classes/RTMClient.md) + +## Interfaces + +- [CodedError](interfaces/CodedError.md) +- [RTMCallResult](interfaces/RTMCallResult.md) +- [RTMClientOptions](interfaces/RTMClientOptions.md) +- [RTMNoReplyReceivedError](interfaces/RTMNoReplyReceivedError.md) +- [RTMPlatformError](interfaces/RTMPlatformError.md) +- [RTMSendWhileDisconnectedError](interfaces/RTMSendWhileDisconnectedError.md) +- [RTMSendWhileNotReadyError](interfaces/RTMSendWhileNotReadyError.md) +- [RTMWebsocketError](interfaces/RTMWebsocketError.md) + +## Type Aliases + +- [RTMCallError](type-aliases/RTMCallError.md) +- [RTMStartOptions](type-aliases/RTMStartOptions.md) + +## Variables + +- [Logger](variables/Logger.md) diff --git a/docs/content/reference/rtm-api/interfaces/CodedError.md b/docs/content/reference/rtm-api/interfaces/CodedError.md new file mode 100644 index 000000000..8f94ea7e1 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/CodedError.md @@ -0,0 +1,27 @@ +# Interface: CodedError + +All errors produced by this package adhere to this interface + +## Extends + +- `ErrnoException` + +## Extended by + +- [`RTMPlatformError`](RTMPlatformError.md) +- [`RTMWebsocketError`](RTMWebsocketError.md) +- [`RTMNoReplyReceivedError`](RTMNoReplyReceivedError.md) +- [`RTMSendWhileDisconnectedError`](RTMSendWhileDisconnectedError.md) +- [`RTMSendWhileNotReadyError`](RTMSendWhileNotReadyError.md) + +## Properties + +### code + +```ts +code: ErrorCode; +``` + +#### Defined in + +[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L7) diff --git a/docs/content/reference/rtm-api/interfaces/RTMCallResult.md b/docs/content/reference/rtm-api/interfaces/RTMCallResult.md new file mode 100644 index 000000000..6a59717f3 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMCallResult.md @@ -0,0 +1,49 @@ +# Interface: RTMCallResult + +## Properties + +### error? + +```ts +optional error: object; +``` + +#### code + +```ts +code: number; +``` + +#### msg + +```ts +msg: string; +``` + +#### Defined in + +[RTMClient.ts:698](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L698) + +*** + +### reply\_to? + +```ts +optional reply_to: number; +``` + +#### Defined in + +[RTMClient.ts:697](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L697) + +*** + +### ts + +```ts +ts: string; +``` + +#### Defined in + +[RTMClient.ts:696](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L696) diff --git a/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md b/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md new file mode 100644 index 000000000..918c272b4 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md @@ -0,0 +1,145 @@ +# Interface: RTMClientOptions + +## Properties + +### agent? + +```ts +optional agent: any; +``` + +#### Defined in + +[RTMClient.ts:682](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L682) + +*** + +### autoReconnect? + +```ts +optional autoReconnect: boolean; +``` + +#### Defined in + +[RTMClient.ts:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L683) + +*** + +### clientPingTimeout? + +```ts +optional clientPingTimeout: number; +``` + +#### Defined in + +[RTMClient.ts:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L687) + +*** + +### logLevel? + +```ts +optional logLevel: any; +``` + +#### Defined in + +[RTMClient.ts:680](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L680) + +*** + +### logger? + +```ts +optional logger: any; +``` + +#### Defined in + +[RTMClient.ts:679](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L679) + +*** + +### replyAckOnReconnectTimeout? + +```ts +optional replyAckOnReconnectTimeout: number; +``` + +#### Defined in + +[RTMClient.ts:689](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L689) + +*** + +### retryConfig? + +```ts +optional retryConfig: any; +``` + +#### Defined in + +[RTMClient.ts:681](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L681) + +*** + +### serverPongTimeout? + +```ts +optional serverPongTimeout: number; +``` + +#### Defined in + +[RTMClient.ts:688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L688) + +*** + +### slackApiUrl? + +```ts +optional slackApiUrl: string; +``` + +#### Defined in + +[RTMClient.ts:678](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L678) + +*** + +### tls? + +```ts +optional tls: any; +``` + +#### Defined in + +[RTMClient.ts:690](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L690) + +*** + +### useRtmConnect? + +```ts +optional useRtmConnect: boolean; +``` + +#### Defined in + +[RTMClient.ts:686](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L686) + +*** + +### webClient? + +```ts +optional webClient: any; +``` + +#### Defined in + +[RTMClient.ts:677](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L677) diff --git a/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md b/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md new file mode 100644 index 000000000..e3394260b --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md @@ -0,0 +1,23 @@ +# Interface: RTMNoReplyReceivedError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: NoReplyReceivedError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L40) diff --git a/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md b/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md new file mode 100644 index 000000000..507970f46 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md @@ -0,0 +1,35 @@ +# Interface: RTMPlatformError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: SendMessagePlatformError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L30) + +*** + +### data + +```ts +data: RTMCallResult; +``` + +#### Defined in + +[errors.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L31) diff --git a/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md b/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md new file mode 100644 index 000000000..812d92be4 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md @@ -0,0 +1,23 @@ +# Interface: RTMSendWhileDisconnectedError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: SendWhileDisconnectedError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L44) diff --git a/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md b/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md new file mode 100644 index 000000000..577135ac2 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md @@ -0,0 +1,23 @@ +# Interface: RTMSendWhileNotReadyError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: SendWhileNotReadyError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L48) diff --git a/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md b/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md new file mode 100644 index 000000000..15c380e52 --- /dev/null +++ b/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md @@ -0,0 +1,35 @@ +# Interface: RTMWebsocketError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: WebsocketError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L35) + +*** + +### original + +```ts +original: Error; +``` + +#### Defined in + +[errors.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L36) diff --git a/docs/content/reference/rtm-api/type-aliases/RTMCallError.md b/docs/content/reference/rtm-api/type-aliases/RTMCallError.md new file mode 100644 index 000000000..abc824c22 --- /dev/null +++ b/docs/content/reference/rtm-api/type-aliases/RTMCallError.md @@ -0,0 +1,14 @@ +# Type Alias: RTMCallError + +```ts +type RTMCallError: + | RTMPlatformError + | RTMWebsocketError + | RTMNoReplyReceivedError + | RTMSendWhileDisconnectedError + | RTMSendWhileNotReadyError; +``` + +## Defined in + +[errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L26) diff --git a/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md b/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md new file mode 100644 index 000000000..8acb7effe --- /dev/null +++ b/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md @@ -0,0 +1,9 @@ +# Type Alias: RTMStartOptions + +```ts +type RTMStartOptions: Logger | Logger; +``` + +## Defined in + +[RTMClient.ts:704](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L704) diff --git a/docs/content/reference/rtm-api/typedoc-sidebar.cjs b/docs/content/reference/rtm-api/typedoc-sidebar.cjs new file mode 100644 index 000000000..58e1b4982 --- /dev/null +++ b/docs/content/reference/rtm-api/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/rtm-api/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/rtm-api/classes/RTMClient","label":"RTMClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/rtm-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMCallResult","label":"RTMCallResult"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMClientOptions","label":"RTMClientOptions"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMNoReplyReceivedError","label":"RTMNoReplyReceivedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMPlatformError","label":"RTMPlatformError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMSendWhileDisconnectedError","label":"RTMSendWhileDisconnectedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMSendWhileNotReadyError","label":"RTMSendWhileNotReadyError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMWebsocketError","label":"RTMWebsocketError"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/rtm-api/type-aliases/RTMCallError","label":"RTMCallError"},{"type":"doc","id":"reference/rtm-api/type-aliases/RTMStartOptions","label":"RTMStartOptions"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/rtm-api/variables/Logger","label":"Logger"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/rtm-api/variables/Logger.md b/docs/content/reference/rtm-api/variables/Logger.md new file mode 100644 index 000000000..e32c0b8c7 --- /dev/null +++ b/docs/content/reference/rtm-api/variables/Logger.md @@ -0,0 +1,5 @@ +# Variable: Logger + +```ts +Logger: any; +``` diff --git a/docs/content/reference/socket-mode/classes/SocketModeClient.md b/docs/content/reference/socket-mode/classes/SocketModeClient.md new file mode 100644 index 000000000..cff68f6fc --- /dev/null +++ b/docs/content/reference/socket-mode/classes/SocketModeClient.md @@ -0,0 +1,115 @@ +# Class: SocketModeClient + +A Socket Mode Client allows programs to communicate with the +[Slack Platform's Events API](https://api.slack.com/events-api) over WebSocket connections. +This object uses the EventEmitter pattern to dispatch incoming events +and has a built in send method to acknowledge incoming events over the WebSocket connection. + +## Extends + +- [`Logger`](../variables/Logger.md) + +## Constructors + +### new SocketModeClient() + +```ts +new SocketModeClient(__namedParameters): SocketModeClient +``` + +#### Parameters + +• **\_\_namedParameters**: [`SocketModeOptions`](../interfaces/SocketModeOptions.md) = `...` + +#### Returns + +[`SocketModeClient`](SocketModeClient.md) + +#### Overrides + +`EventEmitter.constructor` + +#### Defined in + +[packages/socket-mode/src/SocketModeClient.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L99) + +## Properties + +### websocket? + +```ts +optional websocket: SlackWebSocket; +``` + +The underlying WebSocket client instance + +#### Defined in + +[packages/socket-mode/src/SocketModeClient.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L69) + +## Methods + +### disconnect() + +```ts +disconnect(): Promise +``` + +End a Socket Mode session. After this method is called no messages will be sent or received +unless you call start() again later. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/socket-mode/src/SocketModeClient.ts:205](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L205) + +*** + +### onWebSocketMessage() + +```ts +protected onWebSocketMessage(data, isBinary): Promise +``` + +`onmessage` handler for the client's WebSocket. +This will parse the payload and dispatch the application-relevant events for each incoming message. +Mediates: +- raising the State.Connected event (when Slack sends a type:hello message) +- disconnecting the underlying socket (when Slack sends a type:disconnect message) + +#### Parameters + +• **data**: `RawData` + +• **isBinary**: `boolean` + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[packages/socket-mode/src/SocketModeClient.ts:282](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L282) + +*** + +### start() + +```ts +start(): Promise +``` + +Start a Socket Mode session app. +This method must be called before any messages can be sent or received, +or to disconnect the client via the `disconnect` method. + +#### Returns + +`Promise`\<`AppsConnectionsOpenResponse`\> + +#### Defined in + +[packages/socket-mode/src/SocketModeClient.ts:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L163) diff --git a/docs/content/reference/socket-mode/enumerations/ErrorCode.md b/docs/content/reference/socket-mode/enumerations/ErrorCode.md new file mode 100644 index 000000000..cd71b1c17 --- /dev/null +++ b/docs/content/reference/socket-mode/enumerations/ErrorCode.md @@ -0,0 +1,75 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package + +## Enumeration Members + +### InitializationError + +```ts +InitializationError: "slack_socket_mode_initialization_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L17) + +*** + +### NoReplyReceivedError + +```ts +NoReplyReceivedError: "slack_socket_mode_no_reply_received_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L16) + +*** + +### SendMessagePlatformError + +```ts +SendMessagePlatformError: "slack_socket_mode_send_message_platform_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L14) + +*** + +### SendWhileDisconnectedError + +```ts +SendWhileDisconnectedError: "slack_socket_mode_send_while_disconnected_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L12) + +*** + +### SendWhileNotReadyError + +```ts +SendWhileNotReadyError: "slack_socket_mode_send_while_not_ready_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L13) + +*** + +### WebsocketError + +```ts +WebsocketError: "slack_socket_mode_websocket_error"; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L15) diff --git a/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md b/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md new file mode 100644 index 000000000..720734b11 --- /dev/null +++ b/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md @@ -0,0 +1,61 @@ +# Enumeration: UnrecoverableSocketModeStartError + +## Enumeration Members + +### AccountInactive + +```ts +AccountInactive: "account_inactive"; +``` + +#### Defined in + +[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L8) + +*** + +### InvalidAuth + +```ts +InvalidAuth: "invalid_auth"; +``` + +#### Defined in + +[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L7) + +*** + +### NotAuthed + +```ts +NotAuthed: "not_authed"; +``` + +#### Defined in + +[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L6) + +*** + +### TeamDisabled + +```ts +TeamDisabled: "team_disabled"; +``` + +#### Defined in + +[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L10) + +*** + +### UserRemovedFromTeam + +```ts +UserRemovedFromTeam: "user_removed_from_team"; +``` + +#### Defined in + +[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L9) diff --git a/docs/content/reference/socket-mode/index.md b/docs/content/reference/socket-mode/index.md new file mode 100644 index 000000000..9e4708f53 --- /dev/null +++ b/docs/content/reference/socket-mode/index.md @@ -0,0 +1,33 @@ +# @slack/socket-mode + +## References + +### LogLevel + +Renames and re-exports [Logger](variables/Logger.md) + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) +- [UnrecoverableSocketModeStartError](enumerations/UnrecoverableSocketModeStartError.md) + +## Classes + +- [SocketModeClient](classes/SocketModeClient.md) + +## Interfaces + +- [SMNoReplyReceivedError](interfaces/SMNoReplyReceivedError.md) +- [SMPlatformError](interfaces/SMPlatformError.md) +- [SMSendWhileDisconnectedError](interfaces/SMSendWhileDisconnectedError.md) +- [SMSendWhileNotReadyError](interfaces/SMSendWhileNotReadyError.md) +- [SMWebsocketError](interfaces/SMWebsocketError.md) +- [SocketModeOptions](interfaces/SocketModeOptions.md) + +## Type Aliases + +- [SMCallError](type-aliases/SMCallError.md) + +## Variables + +- [Logger](variables/Logger.md) diff --git a/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md b/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md new file mode 100644 index 000000000..1f50807ea --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md @@ -0,0 +1,69 @@ +# Interface: SMNoReplyReceivedError + +## Extends + +- `CodedError` + +## Properties + +### code + +```ts +code: NoReplyReceivedError; +``` + +#### Overrides + +`CodedError.code` + +#### Defined in + +[packages/socket-mode/src/errors.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L35) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`CodedError.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`CodedError.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`CodedError.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMPlatformError.md b/docs/content/reference/socket-mode/interfaces/SMPlatformError.md new file mode 100644 index 000000000..3b54a8644 --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SMPlatformError.md @@ -0,0 +1,81 @@ +# Interface: SMPlatformError + +## Extends + +- `CodedError` + +## Properties + +### code + +```ts +code: SendMessagePlatformError; +``` + +#### Overrides + +`CodedError.code` + +#### Defined in + +[packages/socket-mode/src/errors.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L24) + +*** + +### data + +```ts +data: any; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L26) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`CodedError.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`CodedError.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`CodedError.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md b/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md new file mode 100644 index 000000000..c0058ede8 --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md @@ -0,0 +1,69 @@ +# Interface: SMSendWhileDisconnectedError + +## Extends + +- `CodedError` + +## Properties + +### code + +```ts +code: SendWhileDisconnectedError; +``` + +#### Overrides + +`CodedError.code` + +#### Defined in + +[packages/socket-mode/src/errors.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L39) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`CodedError.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`CodedError.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`CodedError.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md b/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md new file mode 100644 index 000000000..137a0c0ce --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md @@ -0,0 +1,69 @@ +# Interface: SMSendWhileNotReadyError + +## Extends + +- `CodedError` + +## Properties + +### code + +```ts +code: SendWhileNotReadyError; +``` + +#### Overrides + +`CodedError.code` + +#### Defined in + +[packages/socket-mode/src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L43) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`CodedError.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`CodedError.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`CodedError.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md b/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md new file mode 100644 index 000000000..ba71a3021 --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md @@ -0,0 +1,81 @@ +# Interface: SMWebsocketError + +## Extends + +- `CodedError` + +## Properties + +### code + +```ts +code: WebsocketError; +``` + +#### Overrides + +`CodedError.code` + +#### Defined in + +[packages/socket-mode/src/errors.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L30) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`CodedError.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`CodedError.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### original + +```ts +original: Error; +``` + +#### Defined in + +[packages/socket-mode/src/errors.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L31) + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`CodedError.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md b/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md new file mode 100644 index 000000000..69eda330f --- /dev/null +++ b/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md @@ -0,0 +1,123 @@ +# Interface: SocketModeOptions + +## Properties + +### appToken + +```ts +appToken: string; +``` + +The App-level token associated with your app, located under the Basic Information page on api.slack.com/apps. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L8) + +*** + +### autoReconnectEnabled? + +```ts +optional autoReconnectEnabled: boolean; +``` + +Whether the client should automatically reconnect when the socket mode connection is disrupted. Defaults to `true`. +Note that disconnects are regular and expected when using Socket Mode, so setting this to `false` will likely lead +to a disconnected client after some amount of time. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L22) + +*** + +### clientOptions? + +```ts +optional clientOptions: Omit; +``` + +The `@slack/web-api` `WebClientOptions` to provide to the HTTP client interacting with Slack's HTTP API. +Useful for setting retry configurations, TLS and HTTP Agent options. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:46](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L46) + +*** + +### clientPingTimeout? + +```ts +optional clientPingTimeout: number; +``` + +How long the client should wait for a `pong` response to the client's `ping` to the server, in milliseconds. +If this timeout is hit, the client will attempt to reconnect if `autoReconnectEnabled` is `true`; +otherwise, it will disconnect. +Defaults to 5,000. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L29) + +*** + +### logLevel? + +```ts +optional logLevel: any; +``` + +An instance of `@slack/logger`'s LogLevel enum, setting the minimum log level to emit log messages for. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L16) + +*** + +### logger? + +```ts +optional logger: any; +``` + +An instance of `@slack/logger`'s Logger interface, to send log messages to. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L12) + +*** + +### pingPongLoggingEnabled? + +```ts +optional pingPongLoggingEnabled: boolean; +``` + +Should logging related to `ping` and `pong` messages between the client and server be logged at a +`LogLevel.DEBUG` level. Defaults to `false. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L41) + +*** + +### serverPingTimeout? + +```ts +optional serverPingTimeout: number; +``` + +How long the client should wait for `ping` messages from the server, in milliseconds. +If this timeout is hit, the client will attempt to reconnect if `autoReconnectEnabled` is `true`; +otherwise, it will disconnect. +Defaults to 30,000. + +#### Defined in + +[packages/socket-mode/src/SocketModeOptions.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L36) diff --git a/docs/content/reference/socket-mode/type-aliases/SMCallError.md b/docs/content/reference/socket-mode/type-aliases/SMCallError.md new file mode 100644 index 000000000..50c968687 --- /dev/null +++ b/docs/content/reference/socket-mode/type-aliases/SMCallError.md @@ -0,0 +1,14 @@ +# Type Alias: SMCallError + +```ts +type SMCallError: + | SMPlatformError + | SMWebsocketError + | SMNoReplyReceivedError + | SMSendWhileDisconnectedError + | SMSendWhileNotReadyError; +``` + +## Defined in + +[packages/socket-mode/src/errors.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L20) diff --git a/docs/content/reference/socket-mode/typedoc-sidebar.cjs b/docs/content/reference/socket-mode/typedoc-sidebar.cjs new file mode 100644 index 000000000..fc52a0b5e --- /dev/null +++ b/docs/content/reference/socket-mode/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/socket-mode/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/socket-mode/enumerations/UnrecoverableSocketModeStartError","label":"UnrecoverableSocketModeStartError"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/socket-mode/classes/SocketModeClient","label":"SocketModeClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/socket-mode/interfaces/SMNoReplyReceivedError","label":"SMNoReplyReceivedError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMPlatformError","label":"SMPlatformError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMSendWhileDisconnectedError","label":"SMSendWhileDisconnectedError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMSendWhileNotReadyError","label":"SMSendWhileNotReadyError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMWebsocketError","label":"SMWebsocketError"},{"type":"doc","id":"reference/socket-mode/interfaces/SocketModeOptions","label":"SocketModeOptions"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/socket-mode/type-aliases/SMCallError","label":"SMCallError"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/socket-mode/variables/Logger","label":"Logger"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/socket-mode/variables/Logger.md b/docs/content/reference/socket-mode/variables/Logger.md new file mode 100644 index 000000000..e32c0b8c7 --- /dev/null +++ b/docs/content/reference/socket-mode/variables/Logger.md @@ -0,0 +1,5 @@ +# Variable: Logger + +```ts +Logger: any; +``` diff --git a/docs/content/reference/types/index.md b/docs/content/reference/types/index.md new file mode 100644 index 000000000..ab930a3fb --- /dev/null +++ b/docs/content/reference/types/index.md @@ -0,0 +1,108 @@ +# @slack/types + +## Interfaces + +- [Action](interfaces/Action.md) +- [Actionable](interfaces/Actionable.md) +- [ActionsBlock](interfaces/ActionsBlock.md) +- [Block](interfaces/Block.md) +- [Button](interfaces/Button.md) +- [CallUserExternal](interfaces/CallUserExternal.md) +- [CallUserSlack](interfaces/CallUserSlack.md) +- [ChannelsSelect](interfaces/ChannelsSelect.md) +- [Checkboxes](interfaces/Checkboxes.md) +- [Confirm](interfaces/Confirm.md) +- [Confirmable](interfaces/Confirmable.md) +- [Confirmation](interfaces/Confirmation.md) +- [ConfirmationDialog](interfaces/ConfirmationDialog.md) +- [ContextBlock](interfaces/ContextBlock.md) +- [ConversationsSelect](interfaces/ConversationsSelect.md) +- [DateTimepicker](interfaces/DateTimepicker.md) +- [Datepicker](interfaces/Datepicker.md) +- [Dialog](interfaces/Dialog.md) +- [DispatchActionConfig](interfaces/DispatchActionConfig.md) +- [Dispatchable](interfaces/Dispatchable.md) +- [DividerBlock](interfaces/DividerBlock.md) +- [EmailInput](interfaces/EmailInput.md) +- [ExternalSelect](interfaces/ExternalSelect.md) +- [FileBlock](interfaces/FileBlock.md) +- [FileInput](interfaces/FileInput.md) +- [Focusable](interfaces/Focusable.md) +- [HeaderBlock](interfaces/HeaderBlock.md) +- [HomeView](interfaces/HomeView.md) +- [InputBlock](interfaces/InputBlock.md) +- [LinkUnfurls](interfaces/LinkUnfurls.md) +- [MaxItemsSelectable](interfaces/MaxItemsSelectable.md) +- [MessageAttachment](interfaces/MessageAttachment.md) +- [MessageAttachmentField](interfaces/MessageAttachmentField.md) +- [MessageMetadata](interfaces/MessageMetadata.md) +- [MessageMetadataEventPayloadObject](interfaces/MessageMetadataEventPayloadObject.md) +- [ModalView](interfaces/ModalView.md) +- [MrkdwnElement](interfaces/MrkdwnElement.md) +- [MrkdwnOption](interfaces/MrkdwnOption.md) +- [MultiChannelsSelect](interfaces/MultiChannelsSelect.md) +- [MultiConversationsSelect](interfaces/MultiConversationsSelect.md) +- [MultiExternalSelect](interfaces/MultiExternalSelect.md) +- [MultiStaticSelect](interfaces/MultiStaticSelect.md) +- [MultiUsersSelect](interfaces/MultiUsersSelect.md) +- [NumberInput](interfaces/NumberInput.md) +- [OptionGroup](interfaces/OptionGroup.md) +- [Overflow](interfaces/Overflow.md) +- [Placeholdable](interfaces/Placeholdable.md) +- [PlainTextElement](interfaces/PlainTextElement.md) +- [PlainTextInput](interfaces/PlainTextInput.md) +- [PlainTextOption](interfaces/PlainTextOption.md) +- [RadioButtons](interfaces/RadioButtons.md) +- [RichTextBlock](interfaces/RichTextBlock.md) +- [RichTextBorderable](interfaces/RichTextBorderable.md) +- [RichTextBroadcastMention](interfaces/RichTextBroadcastMention.md) +- [RichTextChannelMention](interfaces/RichTextChannelMention.md) +- [RichTextColor](interfaces/RichTextColor.md) +- [RichTextDate](interfaces/RichTextDate.md) +- [RichTextEmoji](interfaces/RichTextEmoji.md) +- [RichTextInput](interfaces/RichTextInput.md) +- [RichTextLink](interfaces/RichTextLink.md) +- [RichTextList](interfaces/RichTextList.md) +- [RichTextPreformatted](interfaces/RichTextPreformatted.md) +- [RichTextQuote](interfaces/RichTextQuote.md) +- [RichTextSection](interfaces/RichTextSection.md) +- [RichTextStyleable](interfaces/RichTextStyleable.md) +- [RichTextTeamMention](interfaces/RichTextTeamMention.md) +- [RichTextText](interfaces/RichTextText.md) +- [RichTextUserMention](interfaces/RichTextUserMention.md) +- [RichTextUsergroupMention](interfaces/RichTextUsergroupMention.md) +- [SectionBlock](interfaces/SectionBlock.md) +- [SelectOption](interfaces/SelectOption.md) +- [SlackFileImageObject](interfaces/SlackFileImageObject.md) +- [StaticSelect](interfaces/StaticSelect.md) +- [Timepicker](interfaces/Timepicker.md) +- [URLInput](interfaces/URLInput.md) +- [URLRespondable](interfaces/URLRespondable.md) +- [UrlImageObject](interfaces/UrlImageObject.md) +- [UsersSelect](interfaces/UsersSelect.md) +- [VideoBlock](interfaces/VideoBlock.md) +- [WorkflowButton](interfaces/WorkflowButton.md) +- [WorkflowStepView](interfaces/WorkflowStepView.md) + +## Type Aliases + +- [ActionsBlockElement](type-aliases/ActionsBlockElement.md) +- [AnyBlock](type-aliases/AnyBlock.md) +- [CallUser](type-aliases/CallUser.md) +- [ColorScheme](type-aliases/ColorScheme.md) +- [ContextBlockElement](type-aliases/ContextBlockElement.md) +- [ConversationFilter](type-aliases/ConversationFilter.md) +- [ConversationType](type-aliases/ConversationType.md) +- [ImageBlock](type-aliases/ImageBlock.md) +- [ImageElement](type-aliases/ImageElement.md) +- [InputBlockElement](type-aliases/InputBlockElement.md) +- [KnownBlock](type-aliases/KnownBlock.md) +- [MultiSelect](type-aliases/MultiSelect.md) +- [Option](type-aliases/Option.md) +- [RichTextBlockElement](type-aliases/RichTextBlockElement.md) +- [RichTextElement](type-aliases/RichTextElement.md) +- [SectionBlockAccessory](type-aliases/SectionBlockAccessory.md) +- [Select](type-aliases/Select.md) +- [SlackFile](type-aliases/SlackFile.md) +- [TextObject](type-aliases/TextObject.md) +- [View](type-aliases/View.md) diff --git a/docs/content/reference/types/interfaces/Action.md b/docs/content/reference/types/interfaces/Action.md new file mode 100644 index 000000000..bd1ee6937 --- /dev/null +++ b/docs/content/reference/types/interfaces/Action.md @@ -0,0 +1,37 @@ +# Interface: ~~Action~~ + +## Deprecated + +[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. + +## Extended by + +- [`Actionable`](Actionable.md) + +## Properties + +### ~~action\_id?~~ + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### ~~type~~ + +```ts +type: string; +``` + +#### Defined in + +[block-kit/extensions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L9) diff --git a/docs/content/reference/types/interfaces/Actionable.md b/docs/content/reference/types/interfaces/Actionable.md new file mode 100644 index 000000000..c0d4b154f --- /dev/null +++ b/docs/content/reference/types/interfaces/Actionable.md @@ -0,0 +1,71 @@ +# Interface: ~~Actionable~~ + +## Deprecated + +[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. + +## Extends + +- [`Action`](Action.md) + +## Extended by + +- [`Button`](Button.md) +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`EmailInput`](EmailInput.md) +- [`FileInput`](FileInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`Overflow`](Overflow.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### ~~action\_id?~~ + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Action`](Action.md).[`action_id`](Action.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### ~~type~~ + +```ts +type: string; +``` + +#### Inherited from + +[`Action`](Action.md).[`type`](Action.md#type) + +#### Defined in + +[block-kit/extensions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L9) diff --git a/docs/content/reference/types/interfaces/ActionsBlock.md b/docs/content/reference/types/interfaces/ActionsBlock.md new file mode 100644 index 000000000..bc0d72be5 --- /dev/null +++ b/docs/content/reference/types/interfaces/ActionsBlock.md @@ -0,0 +1,74 @@ +# Interface: ActionsBlock + +## Description + +Holds multiple interactive elements. + +## See + +[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### elements + +```ts +elements: ActionsBlockElement[]; +``` + +#### Description + +An array of InteractiveElements objects. +There is a maximum of 25 elements in each action block. + +#### Defined in + +[block-kit/blocks.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L80) + +*** + +### type + +```ts +type: "actions"; +``` + +#### Description + +The type of block. For an actions block, `type` is always `actions`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L75) diff --git a/docs/content/reference/types/interfaces/Block.md b/docs/content/reference/types/interfaces/Block.md new file mode 100644 index 000000000..a1b3ad885 --- /dev/null +++ b/docs/content/reference/types/interfaces/Block.md @@ -0,0 +1,49 @@ +# Interface: Block + +## Extended by + +- [`ActionsBlock`](ActionsBlock.md) +- [`ContextBlock`](ContextBlock.md) +- [`DividerBlock`](DividerBlock.md) +- [`FileBlock`](FileBlock.md) +- [`HeaderBlock`](HeaderBlock.md) +- [`InputBlock`](InputBlock.md) +- [`RichTextBlock`](RichTextBlock.md) +- [`SectionBlock`](SectionBlock.md) +- [`VideoBlock`](VideoBlock.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### type + +```ts +type: string; +``` + +#### Description + +The type of block. + +#### Defined in + +[block-kit/blocks.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L36) diff --git a/docs/content/reference/types/interfaces/Button.md b/docs/content/reference/types/interfaces/Button.md new file mode 100644 index 000000000..b677c3277 --- /dev/null +++ b/docs/content/reference/types/interfaces/Button.md @@ -0,0 +1,165 @@ +# Interface: Button + +## Description + +Allows users a direct path to performing basic actions. + +## See + + - [Button element reference](https://api.slack.com/reference/block-kit/block-elements#button). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) + +## Properties + +### accessibility\_label? + +```ts +optional accessibility_label: string; +``` + +#### Description + +A label for longer descriptive text about a button element. This label will be read out by screen +readers instead of the button `text` object. Maximum length for this field is 75 characters. + +#### Defined in + +[block-kit/block-elements.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L63) + +*** + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### style? + +```ts +optional style: ColorScheme; +``` + +#### Description + +Decorates buttons with alternative visual color schemes. Use this option with restraint. +`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should +only be used for one button within a set. +`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even +more sparingly than primary. +If you don't include this field, the default button style will be used. + +#### Defined in + +[block-kit/block-elements.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L58) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. +Maximum length for the text in this field is 75 characters. + +#### Defined in + +[block-kit/block-elements.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L38) + +*** + +### type + +```ts +type: "button"; +``` + +#### Description + +The type of element. In this case `type` is always `button`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L33) + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 +characters. If you're using `url`, you'll still receive an [interaction payload](https://api.slack.com/interactivity/handling#payloads) +and will need to send an [acknowledgement response](https://api.slack.com/interactivity/handling#acknowledgment_response). + +#### Defined in + +[block-kit/block-elements.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L49) + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +The value to send along with the [interaction payload](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 2000 characters. + +#### Defined in + +[block-kit/block-elements.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L43) diff --git a/docs/content/reference/types/interfaces/CallUserExternal.md b/docs/content/reference/types/interfaces/CallUserExternal.md new file mode 100644 index 000000000..0182a2f8d --- /dev/null +++ b/docs/content/reference/types/interfaces/CallUserExternal.md @@ -0,0 +1,49 @@ +# Interface: CallUserExternal + +## Properties + +### avatar\_url? + +```ts +optional avatar_url: string; +``` + +#### Description + +URL to an avatar image of the user. + +#### Defined in + +[calls.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L30) + +*** + +### display\_name + +```ts +display_name: string; +``` + +#### Description + +Name of the user to be displayed in the Call block in a message. + +#### Defined in + +[calls.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L26) + +*** + +### external\_id + +```ts +external_id: string; +``` + +#### Description + +A unique ID created by your app to represent your users. + +#### Defined in + +[calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L22) diff --git a/docs/content/reference/types/interfaces/CallUserSlack.md b/docs/content/reference/types/interfaces/CallUserSlack.md new file mode 100644 index 000000000..ad6df8881 --- /dev/null +++ b/docs/content/reference/types/interfaces/CallUserSlack.md @@ -0,0 +1,18 @@ +# Interface: CallUserSlack + +## Properties + +### slack\_id + +```ts +slack_id: string; +``` + +#### Description + +The Slack encoded user ID, e.g. U1234ABCD. Set this if you have it or know it, otherwise, set +`external_id` and `display_name`. + +#### Defined in + +[calls.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L15) diff --git a/docs/content/reference/types/interfaces/ChannelsSelect.md b/docs/content/reference/types/interfaces/ChannelsSelect.md new file mode 100644 index 000000000..9fadc4e91 --- /dev/null +++ b/docs/content/reference/types/interfaces/ChannelsSelect.md @@ -0,0 +1,158 @@ +# Interface: ChannelsSelect + +## Description + +This select menu will populate its options with a list of public channels visible to the current user +in the active workspace. + +## See + + - [Select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channels_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md).[`URLRespondable`](URLRespondable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_channel? + +```ts +optional initial_channel: string; +``` + +#### Description + +The ID of any valid public channel to be pre-selected when the menu loads. + +#### Defined in + +[block-kit/block-elements.ts:448](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L448) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### response\_url\_enabled? + +```ts +optional response_url_enabled: boolean; +``` + +#### Description + +When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) +from the menu's parent view will contain a `response_url`. This `response_url` can be used for +[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation +for the message will be determined by the value of this select menu. + +#### Inherited from + +[`URLRespondable`](URLRespondable.md).[`response_url_enabled`](URLRespondable.md#response_url_enabled) + +#### Defined in + +[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) + +*** + +### type + +```ts +type: "channels_select"; +``` + +#### Description + +The type of element. In this case `type` is always `channels_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:444](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L444) diff --git a/docs/content/reference/types/interfaces/Checkboxes.md b/docs/content/reference/types/interfaces/Checkboxes.md new file mode 100644 index 000000000..e644e385b --- /dev/null +++ b/docs/content/reference/types/interfaces/Checkboxes.md @@ -0,0 +1,130 @@ +# Interface: Checkboxes + +## Description + +Allows users to choose multiple items from a list of options. + +## See + + - [Checkboxes element reference](https://api.slack.com/reference/block-kit/block-elements#checkboxes). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_options? + +```ts +optional initial_options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects that exactly matches one or more of the options within `options`. +These options will be selected when the checkbox group initially loads. + +#### Defined in + +[block-kit/block-elements.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L80) + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. + +#### Defined in + +[block-kit/block-elements.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L84) + +*** + +### type + +```ts +type: "checkboxes"; +``` + +#### Description + +The type of element. In this case `type` is always `checkboxes`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L75) diff --git a/docs/content/reference/types/interfaces/Confirm.md b/docs/content/reference/types/interfaces/Confirm.md new file mode 100644 index 000000000..e0b67389c --- /dev/null +++ b/docs/content/reference/types/interfaces/Confirm.md @@ -0,0 +1,104 @@ +# Interface: ~~Confirm~~ + +## Deprecated + +[Confirm](Confirm.md) aliased to [ConfirmationDialog](ConfirmationDialog.md) in order to make the construct clearer +and line up terminology with api.slack.com. + +## Description + +Defines a dialog that adds a confirmation step to interactive elements. + +## See + +[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). + +## Extended by + +- [`ConfirmationDialog`](ConfirmationDialog.md) + +## Properties + +### ~~confirm?~~ + +```ts +optional confirm: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. +Maximum length for the `text` in this field is 30 characters. + +#### Defined in + +[block-kit/composition-objects.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L34) + +*** + +### ~~deny?~~ + +```ts +optional deny: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. +Maximum length for the `text` in this field is 30 characters. + +#### Defined in + +[block-kit/composition-objects.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L39) + +*** + +### ~~style?~~ + +```ts +optional style: ColorScheme; +``` + +#### Description + +Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button +with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green +background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. + +#### Defined in + +[block-kit/composition-objects.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L45) + +*** + +### ~~text~~ + +```ts +text: PlainTextElement | MrkdwnElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm +dialog. Maximum length for the `text` in this field is 300 characters. + +#### Defined in + +[block-kit/composition-objects.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L29) + +*** + +### ~~title?~~ + +```ts +optional title: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. +Maximum length for this field is 100 characters. + +#### Defined in + +[block-kit/composition-objects.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L24) diff --git a/docs/content/reference/types/interfaces/Confirmable.md b/docs/content/reference/types/interfaces/Confirmable.md new file mode 100644 index 000000000..08bf4fa92 --- /dev/null +++ b/docs/content/reference/types/interfaces/Confirmable.md @@ -0,0 +1,39 @@ +# Interface: Confirmable + +## Extended by + +- [`Button`](Button.md) +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`Overflow`](Overflow.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`WorkflowButton`](WorkflowButton.md) + +## Properties + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) diff --git a/docs/content/reference/types/interfaces/Confirmation.md b/docs/content/reference/types/interfaces/Confirmation.md new file mode 100644 index 000000000..8f959c3d5 --- /dev/null +++ b/docs/content/reference/types/interfaces/Confirmation.md @@ -0,0 +1,49 @@ +# Interface: Confirmation + +## Properties + +### dismiss\_text? + +```ts +optional dismiss_text: string; +``` + +#### Defined in + +[message-attachments.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L177) + +*** + +### ok\_text? + +```ts +optional ok_text: string; +``` + +#### Defined in + +[message-attachments.ts:178](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L178) + +*** + +### text + +```ts +text: string; +``` + +#### Defined in + +[message-attachments.ts:179](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L179) + +*** + +### title? + +```ts +optional title: string; +``` + +#### Defined in + +[message-attachments.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L180) diff --git a/docs/content/reference/types/interfaces/ConfirmationDialog.md b/docs/content/reference/types/interfaces/ConfirmationDialog.md new file mode 100644 index 000000000..1cecde5dd --- /dev/null +++ b/docs/content/reference/types/interfaces/ConfirmationDialog.md @@ -0,0 +1,119 @@ +# Interface: ConfirmationDialog + +## Description + +Defines a dialog that adds a confirmation step to interactive elements. + +## See + +[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). + +## Extends + +- [`Confirm`](Confirm.md) + +## Properties + +### confirm? + +```ts +optional confirm: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. +Maximum length for the `text` in this field is 30 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`confirm`](Confirm.md#confirm) + +#### Defined in + +[block-kit/composition-objects.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L34) + +*** + +### deny? + +```ts +optional deny: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. +Maximum length for the `text` in this field is 30 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`deny`](Confirm.md#deny) + +#### Defined in + +[block-kit/composition-objects.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L39) + +*** + +### style? + +```ts +optional style: ColorScheme; +``` + +#### Description + +Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button +with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green +background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. + +#### Inherited from + +[`Confirm`](Confirm.md).[`style`](Confirm.md#style) + +#### Defined in + +[block-kit/composition-objects.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L45) + +*** + +### text + +```ts +text: PlainTextElement | MrkdwnElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm +dialog. Maximum length for the `text` in this field is 300 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`text`](Confirm.md#text) + +#### Defined in + +[block-kit/composition-objects.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L29) + +*** + +### title? + +```ts +optional title: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. +Maximum length for this field is 100 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`title`](Confirm.md#title) + +#### Defined in + +[block-kit/composition-objects.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L24) diff --git a/docs/content/reference/types/interfaces/ContextBlock.md b/docs/content/reference/types/interfaces/ContextBlock.md new file mode 100644 index 000000000..6164a2388 --- /dev/null +++ b/docs/content/reference/types/interfaces/ContextBlock.md @@ -0,0 +1,74 @@ +# Interface: ContextBlock + +## Description + +Displays contextual info, which can include both images and text. + +## See + +[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### elements + +```ts +elements: ContextBlockElement[]; +``` + +#### Description + +An array of [ImageElement](../type-aliases/ImageElement.md), [PlainTextElement](PlainTextElement.md) or [MrkdwnElement](MrkdwnElement.md) objects. +Maximum number of items is 10. + +#### Defined in + +[block-kit/blocks.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L102) + +*** + +### type + +```ts +type: "context"; +``` + +#### Description + +The type of block. For a context block, `type` is always `context`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L97) diff --git a/docs/content/reference/types/interfaces/ConversationsSelect.md b/docs/content/reference/types/interfaces/ConversationsSelect.md new file mode 100644 index 000000000..60a626c91 --- /dev/null +++ b/docs/content/reference/types/interfaces/ConversationsSelect.md @@ -0,0 +1,210 @@ +# Interface: ConversationsSelect + +## Description + +This select menu will populate its options with a list of public and private channels, DMs, and MPIMs +visible to the current user in the active workspace. + +## See + + - [Select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversations_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md).[`URLRespondable`](URLRespondable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### default\_to\_current\_conversation? + +```ts +optional default_to_current_conversation: boolean; +``` + +#### Description + +Pre-populates the select menu with the conversation that the user was viewing when they opened the +modal, if available. Default is `false`. + +#### Defined in + +[block-kit/block-elements.ts:377](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L377) + +*** + +### filter? + +```ts +optional filter: object; +``` + +#### exclude\_bot\_users? + +```ts +optional exclude_bot_users: boolean; +``` + +#### exclude\_external\_shared\_channels? + +```ts +optional exclude_external_shared_channels: boolean; +``` + +#### include? + +```ts +optional include: ("im" | "mpim" | "private" | "public")[]; +``` + +#### Description + +A filter object that reduces the list of available conversations using the specified criteria. + +#### Defined in + +[block-kit/block-elements.ts:381](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L381) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_conversation? + +```ts +optional initial_conversation: string; +``` + +#### Description + +The ID of any valid conversation to be pre-selected when the menu loads. If +`default_to_current_conversation` is also supplied, `initial_conversation` will take precedence. + +#### Defined in + +[block-kit/block-elements.ts:372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L372) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### response\_url\_enabled? + +```ts +optional response_url_enabled: boolean; +``` + +#### Description + +When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) +from the menu's parent view will contain a `response_url`. This `response_url` can be used for +[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation +for the message will be determined by the value of this select menu. + +#### Inherited from + +[`URLRespondable`](URLRespondable.md).[`response_url_enabled`](URLRespondable.md#response_url_enabled) + +#### Defined in + +[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) + +*** + +### type + +```ts +type: "conversations_select"; +``` + +#### Description + +The type of element. In this case `type` is always `conversations_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L367) diff --git a/docs/content/reference/types/interfaces/DateTimepicker.md b/docs/content/reference/types/interfaces/DateTimepicker.md new file mode 100644 index 000000000..478003493 --- /dev/null +++ b/docs/content/reference/types/interfaces/DateTimepicker.md @@ -0,0 +1,118 @@ +# Interface: DateTimepicker + +## Description + +Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop +clients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown +calendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date +picker will use native UIs. + +## See + + - [Datetime picker element reference](https://api.slack.com/reference/block-kit/block-elements#datetimepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_date\_time? + +```ts +optional initial_date_time: number; +``` + +#### Description + +The initial date and time that is selected when the element is loaded, represented as a UNIX +timestamp in seconds. This should be in the format of 10 digits, for example `1628633820` represents the date and +time August 10th, 2021 at 03:17pm PST. + +#### Defined in + +[block-kit/block-elements.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L126) + +*** + +### type + +```ts +type: "datetimepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `datetimepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L120) diff --git a/docs/content/reference/types/interfaces/Datepicker.md b/docs/content/reference/types/interfaces/Datepicker.md new file mode 100644 index 000000000..27daa3695 --- /dev/null +++ b/docs/content/reference/types/interfaces/Datepicker.md @@ -0,0 +1,135 @@ +# Interface: Datepicker + +## Description + +Allows users to select a date from a calendar style UI. + +## See + + - [Date picker element reference](https://api.slack.com/reference/block-kit/block-elements#datepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_date? + +```ts +optional initial_date: string; +``` + +#### Description + +The initial date that is selected when the element is loaded. +This should be in the format `YYYY-MM-DD`. + +#### Defined in + +[block-kit/block-elements.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L105) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "datepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `datepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L100) diff --git a/docs/content/reference/types/interfaces/Dialog.md b/docs/content/reference/types/interfaces/Dialog.md new file mode 100644 index 000000000..dbfb40924 --- /dev/null +++ b/docs/content/reference/types/interfaces/Dialog.md @@ -0,0 +1,79 @@ +# Interface: ~~Dialog~~ + +Reusable shapes for argument values + +## Deprecated + +Dialogs are a deprecated surface in Slack. For more details on how to upgrade, check out our [Upgrading outmoded dialogs to modals guide](https://api.slack.com/block-kit/dialogs-to-modals). This will be removed in the next major version. + +## Properties + +### ~~callback\_id~~ + +```ts +callback_id: string; +``` + +#### Defined in + +[dialog.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L7) + +*** + +### ~~elements~~ + +```ts +elements: object[]; +``` + +#### Defined in + +[dialog.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L8) + +*** + +### ~~notify\_on\_cancel?~~ + +```ts +optional notify_on_cancel: boolean; +``` + +#### Defined in + +[dialog.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L31) + +*** + +### ~~state?~~ + +```ts +optional state: string; +``` + +#### Defined in + +[dialog.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L32) + +*** + +### ~~submit\_label?~~ + +```ts +optional submit_label: string; +``` + +#### Defined in + +[dialog.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L30) + +*** + +### ~~title~~ + +```ts +title: string; +``` + +#### Defined in + +[dialog.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L6) diff --git a/docs/content/reference/types/interfaces/DispatchActionConfig.md b/docs/content/reference/types/interfaces/DispatchActionConfig.md new file mode 100644 index 000000000..803ae38e3 --- /dev/null +++ b/docs/content/reference/types/interfaces/DispatchActionConfig.md @@ -0,0 +1,30 @@ +# Interface: DispatchActionConfig + +## Description + +Defines when a [PlainTextElement](PlainTextElement.md) will return a [`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +## See + +[`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +## Properties + +### trigger\_actions\_on? + +```ts +optional trigger_actions_on: ("on_enter_pressed" | "on_character_entered")[]; +``` + +#### Description + +An array of interaction types that you would like to receive a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions) for. Should be +one or both of: + `on_enter_pressed` — payload is dispatched when user presses the enter key while the input is in focus. Hint + text will appear underneath the input explaining to the user to press enter to submit. + `on_character_entered` — payload is dispatched when a character is entered (or removed) in the input. + +#### Defined in + +[block-kit/composition-objects.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L67) diff --git a/docs/content/reference/types/interfaces/Dispatchable.md b/docs/content/reference/types/interfaces/Dispatchable.md new file mode 100644 index 000000000..71d495076 --- /dev/null +++ b/docs/content/reference/types/interfaces/Dispatchable.md @@ -0,0 +1,26 @@ +# Interface: Dispatchable + +## Extended by + +- [`EmailInput`](EmailInput.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) diff --git a/docs/content/reference/types/interfaces/DividerBlock.md b/docs/content/reference/types/interfaces/DividerBlock.md new file mode 100644 index 000000000..1c5143f28 --- /dev/null +++ b/docs/content/reference/types/interfaces/DividerBlock.md @@ -0,0 +1,58 @@ +# Interface: DividerBlock + +## Description + +Visually separates pieces of info inside of a message. A content divider, like an `
`, to split up +different blocks inside of a message. The divider block is nice and neat, requiring only a `type`. + +## See + +[Divider block reference](https://api.slack.com/reference/block-kit/blocks#divider). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### type + +```ts +type: "divider"; +``` + +#### Description + +The type of block. For a divider block, `type` is always `divider`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L114) diff --git a/docs/content/reference/types/interfaces/EmailInput.md b/docs/content/reference/types/interfaces/EmailInput.md new file mode 100644 index 000000000..2575bcb46 --- /dev/null +++ b/docs/content/reference/types/interfaces/EmailInput.md @@ -0,0 +1,134 @@ +# Interface: EmailInput + +## Description + +Allows user to enter an email into a single-line field. + +## See + + - [Email input element reference](https://api.slack.com/reference/block-kit/block-elements#email). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the email input when it is loaded. + +#### Defined in + +[block-kit/block-elements.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L146) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "email_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `email_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L142) diff --git a/docs/content/reference/types/interfaces/ExternalSelect.md b/docs/content/reference/types/interfaces/ExternalSelect.md new file mode 100644 index 000000000..f59494485 --- /dev/null +++ b/docs/content/reference/types/interfaces/ExternalSelect.md @@ -0,0 +1,153 @@ +# Interface: ExternalSelect + +## Description + +This select menu will load its options from an external data source, allowing for a dynamic list of +options. + +## See + + - [Select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_option? + +```ts +optional initial_option: PlainTextOption; +``` + +#### Description + +A single option to be selected when the menu initially loads. + +#### Defined in + +[block-kit/block-elements.ts:493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L493) + +*** + +### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### Description + +When the typeahead field is used, a request will be sent on every character change. If you prefer +fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number +of typed characters required before dispatch. The default value is `3`. + +#### Defined in + +[block-kit/block-elements.ts:499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L499) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "external_select"; +``` + +#### Description + +The type of element. In this case `type` is always `external_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L488) diff --git a/docs/content/reference/types/interfaces/FileBlock.md b/docs/content/reference/types/interfaces/FileBlock.md new file mode 100644 index 000000000..05db04a2e --- /dev/null +++ b/docs/content/reference/types/interfaces/FileBlock.md @@ -0,0 +1,92 @@ +# Interface: FileBlock + +## Description + +Displays a [remote file](https://api.slack.com/messaging/files/remote). You can't add this block to +app surfaces directly, but it will show up when [retrieving messages](https://api.slack.com/messaging/retrieving) +that contain remote files. If you want to add remote files to messages, +[follow our guide](https://api.slack.com/messaging/files/remote). + +## See + +[File block reference](https://api.slack.com/reference/block-kit/blocks#file). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### external\_id + +```ts +external_id: string; +``` + +#### Description + +The external unique ID for this file. + +#### Defined in + +[block-kit/blocks.ts:136](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L136) + +*** + +### source + +```ts +source: string; +``` + +#### Description + +At the moment, source will always be `remote` for a remote file. + +#### Defined in + +[block-kit/blocks.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L132) + +*** + +### type + +```ts +type: "file"; +``` + +#### Description + +The type of block. For a file block, `type` is always `file`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L128) diff --git a/docs/content/reference/types/interfaces/FileInput.md b/docs/content/reference/types/interfaces/FileInput.md new file mode 100644 index 000000000..833271a9e --- /dev/null +++ b/docs/content/reference/types/interfaces/FileInput.md @@ -0,0 +1,89 @@ +# Interface: FileInput + +## Description + +Allows user to upload files. In order to use the `file_input` element within your app, +your app must have the `files:read` scope. + +## See + +[File input element reference](https://api.slack.com/reference/block-kit/block-elements#file_input). + +## Extends + +- [`Actionable`](Actionable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### filetypes? + +```ts +optional filetypes: string[]; +``` + +#### Description + +An array of valid [file extensions](https://api.slack.com/types/file#types) that will be accepted +for this element. All file extensions will be accepted if `filetypes` is not specified. This validation is provided +for convenience only, and you should perform your own file type validation based on what you expect to receive. + +#### Defined in + +[block-kit/block-elements.ts:164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L164) + +*** + +### max\_files? + +```ts +optional max_files: number; +``` + +#### Description + +Maximum number of files that can be uploaded for this `file_input` element. Minimum of `1`, maximum of +`10`. Defaults to `10` if not specified. + +#### Defined in + +[block-kit/block-elements.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L169) + +*** + +### type + +```ts +type: "file_input"; +``` + +#### Description + +The type of element. In this case `type` is always `file_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L158) diff --git a/docs/content/reference/types/interfaces/Focusable.md b/docs/content/reference/types/interfaces/Focusable.md new file mode 100644 index 000000000..fac8198f5 --- /dev/null +++ b/docs/content/reference/types/interfaces/Focusable.md @@ -0,0 +1,42 @@ +# Interface: Focusable + +## Extended by + +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`EmailInput`](EmailInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) diff --git a/docs/content/reference/types/interfaces/HeaderBlock.md b/docs/content/reference/types/interfaces/HeaderBlock.md new file mode 100644 index 000000000..bbb9c30bc --- /dev/null +++ b/docs/content/reference/types/interfaces/HeaderBlock.md @@ -0,0 +1,75 @@ +# Interface: HeaderBlock + +## Description + +Displays a larger-sized text block. A `header` is a plain-text block that displays in a larger, bold +font. Use it to delineate between different groups of content in your app's surfaces. + +## See + +[Header block reference](https://api.slack.com/reference/block-kit/blocks#header). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +The text for the block, in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 150 characters. + +#### Defined in + +[block-kit/blocks.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L153) + +*** + +### type + +```ts +type: "header"; +``` + +#### Description + +The type of block. For a header block, `type` is always `header`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:148](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L148) diff --git a/docs/content/reference/types/interfaces/HomeView.md b/docs/content/reference/types/interfaces/HomeView.md new file mode 100644 index 000000000..6d6318cd3 --- /dev/null +++ b/docs/content/reference/types/interfaces/HomeView.md @@ -0,0 +1,109 @@ +# Interface: HomeView + +## Extends + +- `BaseView` + +## Properties + +### blocks + +```ts +blocks: AnyBlock[]; +``` + +#### Description + +An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. + +#### Inherited from + +`BaseView.blocks` + +#### Defined in + +[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Description + +An identifier to recognize interactions and submissions of this particular view. Don't use this to +store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. + +#### See + +[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). + +#### Inherited from + +`BaseView.callback_id` + +#### Defined in + +[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) + +*** + +### external\_id? + +```ts +optional external_id: string; +``` + +#### Description + +A custom identifier that must be unique for all views on a per-team basis. + +#### Inherited from + +`BaseView.external_id` + +#### Defined in + +[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) + +*** + +### private\_metadata? + +```ts +optional private_metadata: string; +``` + +#### Description + +String that will be sent to your app in +[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and +[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. +Maximum length of 3000 characters. + +#### Inherited from + +`BaseView.private_metadata` + +#### Defined in + +[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) + +*** + +### type + +```ts +type: "home"; +``` + +#### Description + +The type of view. Set to `home` for Home tabs. + +#### Defined in + +[views.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L27) diff --git a/docs/content/reference/types/interfaces/InputBlock.md b/docs/content/reference/types/interfaces/InputBlock.md new file mode 100644 index 000000000..ca33952ca --- /dev/null +++ b/docs/content/reference/types/interfaces/InputBlock.md @@ -0,0 +1,143 @@ +# Interface: InputBlock + +## Description + +Collects information from users via block elements. + +## See + + - [Input block reference](https://api.slack.com/reference/block-kit/blocks#input). + - [Collecting input in modals guide](https://api.slack.com/surfaces/modals#gathering_input). + - [Collecting input in Home tabs guide](https://api.slack.com/surfaces/app-home#gathering_input). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### dispatch\_action? + +```ts +optional dispatch_action: boolean; +``` + +#### Description + +A boolean that indicates whether or not the use of elements in this block should dispatch a +[block_actions payload](https://api.slack.com/reference/interaction-payloads/block-actions). Defaults to `false`. + +#### Defined in + +[block-kit/blocks.ts:218](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L218) + +*** + +### element + +```ts +element: InputBlockElement; +``` + +#### Description + +A block element. + +#### Defined in + +[block-kit/blocks.ts:213](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L213) + +*** + +### hint? + +```ts +optional hint: PlainTextElement; +``` + +#### Description + +An optional hint that appears below an input element in a lighter grey. It must be a +[object](PlainTextElement.md). Maximum length for the `text` in this field is 2000 characters. + +#### Defined in + +[block-kit/blocks.ts:204](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L204) + +*** + +### label + +```ts +label: PlainTextElement; +``` + +#### Description + +A label that appears above an input element in the form of a [PlainTextElement](PlainTextElement.md) object. +Maximum length for the text in this field is 2000 characters. + +#### Defined in + +[block-kit/blocks.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L199) + +*** + +### optional? + +```ts +optional optional: boolean; +``` + +#### Description + +A boolean that indicates whether the input element may be empty when a user submits the modal. +Defaults to `false`. + +#### Defined in + +[block-kit/blocks.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L209) + +*** + +### type + +```ts +type: "input"; +``` + +#### Description + +The type of block. For an input block, `type` is always `input`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:194](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L194) diff --git a/docs/content/reference/types/interfaces/LinkUnfurls.md b/docs/content/reference/types/interfaces/LinkUnfurls.md new file mode 100644 index 000000000..d041ae784 --- /dev/null +++ b/docs/content/reference/types/interfaces/LinkUnfurls.md @@ -0,0 +1,5 @@ +# Interface: LinkUnfurls + +## Indexable + + \[`linkUrl`: `string`\]: [`MessageAttachment`](MessageAttachment.md) diff --git a/docs/content/reference/types/interfaces/MaxItemsSelectable.md b/docs/content/reference/types/interfaces/MaxItemsSelectable.md new file mode 100644 index 000000000..ab49365c4 --- /dev/null +++ b/docs/content/reference/types/interfaces/MaxItemsSelectable.md @@ -0,0 +1,25 @@ +# Interface: MaxItemsSelectable + +## Extended by + +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) + +## Properties + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) diff --git a/docs/content/reference/types/interfaces/MessageAttachment.md b/docs/content/reference/types/interfaces/MessageAttachment.md new file mode 100644 index 000000000..4585932f5 --- /dev/null +++ b/docs/content/reference/types/interfaces/MessageAttachment.md @@ -0,0 +1,401 @@ +# Interface: MessageAttachment + +Add [secondary attachments](https://api.slack.com/messaging/composing/layouts#attachments) to your messages in Slack. +Message attachments are considered a legacy part of messaging functionality. They are not deprecated per se, but they may change in the future, in ways that reduce their visibility or utility. We recommend moving to Block Kit instead. Read more about [when to use message attachments](https://api.slack.com/messaging/composing/layouts#when-to-use-attachments). + +## See + +[Secondary message attachments reference documentation](https://api.slack.com/reference/messaging/attachments) + +## Properties + +### actions? + +```ts +optional actions: AttachmentAction[]; +``` + +#### Defined in + +[message-attachments.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L105) + +*** + +### app\_id? + +```ts +optional app_id: string; +``` + +#### Defined in + +[message-attachments.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L115) + +*** + +### app\_unfurl\_url? + +```ts +optional app_unfurl_url: string; +``` + +#### Defined in + +[message-attachments.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L113) + +*** + +### author\_icon? + +```ts +optional author_icon: string; +``` + +#### Description + +A valid URL that displays a small 16px by 16px image to the left of the `author_name` text. +Will only work if `author_name` is present. + +#### Defined in + +[message-attachments.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L49) + +*** + +### author\_link? + +```ts +optional author_link: string; +``` + +#### Description + +A valid URL that will hyperlink the `author_name` text. Will only work if `author_name` is present. + +#### Defined in + +[message-attachments.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L44) + +*** + +### author\_name? + +```ts +optional author_name: string; +``` + +#### Description + +Small text used to display the author's name. + +#### Defined in + +[message-attachments.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L40) + +*** + +### author\_subname? + +```ts +optional author_subname: string; +``` + +#### Defined in + +[message-attachments.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L50) + +*** + +### blocks? + +```ts +optional blocks: AnyBlock[]; +``` + +#### Description + +An array of [layout blocks](../type-aliases/KnownBlock.md) in the same format +[as described in the building blocks guide](https://api.slack.com/block-kit/building). + +#### Defined in + +[message-attachments.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L21) + +*** + +### bot\_id? + +```ts +optional bot_id: string; +``` + +#### Defined in + +[message-attachments.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L116) + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Defined in + +[message-attachments.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L106) + +*** + +### color? + +```ts +optional color: string; +``` + +#### Description + +Changes the color of the border on the left side of this attachment from the default gray. Can either +be one of `good` (green), `warning` (yellow), `danger` (red), or any hex color code (eg. `#439FE0`) + +#### Defined in + +[message-attachments.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L31) + +*** + +### fallback? + +```ts +optional fallback: string; +``` + +#### Description + +A plain text summary of the attachment used in clients that +don't show formatted text (e.g. mobile notifications). + +#### Defined in + +[message-attachments.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L26) + +*** + +### fields? + +```ts +optional fields: MessageAttachmentField[]; +``` + +#### Description + +An array of [MessageAttachmentField](MessageAttachmentField.md) that get displayed in a table-like way +(see [this example](https://api.slack.com/reference/messaging/attachments#example)). +For best results, include no more than 2-3 field objects. + +#### Defined in + +[message-attachments.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L71) + +*** + +### footer? + +```ts +optional footer: string; +``` + +#### Description + +Some brief text to help contextualize and identify an attachment. Limited to 300 characters, +and may be truncated further when displayed to users in environments with limited screen real estate. + +#### Defined in + +[message-attachments.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L91) + +*** + +### footer\_icon? + +```ts +optional footer_icon: string; +``` + +#### Description + +A valid URL to an image file that will be displayed beside the `footer` text. +Will only work if `footer` is present. We'll render what you provide at 16px by 16px. +It's best to use an image that is similarly sized. + +#### Defined in + +[message-attachments.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L97) + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +#### Description + +A valid URL to an image file that will be displayed at the bottom of the attachment. +We support GIF, JPEG, PNG, and BMP formats. +Large images will be resized to a maximum width of 360px or a maximum height of 500px, while still +maintaining the original aspect ratio. Cannot be used with `thumb_url`. + +#### Defined in + +[message-attachments.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L78) + +*** + +### is\_app\_unfurl? + +```ts +optional is_app_unfurl: boolean; +``` + +#### Defined in + +[message-attachments.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L114) + +*** + +### mrkdwn\_in? + +```ts +optional mrkdwn_in: ("text" | "pretext" | "fields")[]; +``` + +#### Description + +Field names that should be [formatted by `mrkdwn` syntax](https://api.slack.com/reference/surfaces/formatting#basics). +The fields that can be formatted in this way include the names of the `fields` property, or +the `text` or `pretext` properties. + +#### Defined in + +[message-attachments.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L112) + +*** + +### pretext? + +```ts +optional pretext: string; +``` + +#### Description + +Text that appears above the message attachment block. It can be formatted as plain text, +or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. + +#### Defined in + +[message-attachments.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L36) + +*** + +### preview? + +```ts +optional preview: MessageAttachmentPreview; +``` + +#### Defined in + +[message-attachments.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L117) + +*** + +### text? + +```ts +optional text: string; +``` + +#### Description + +The main body text of the attachment. It can be formatted as plain text, or with +[`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. +The content will automatically collapse if it contains 700+ characters or 5+ line breaks, and will display +a "Show more..." link to expand the content. + +#### Defined in + +[message-attachments.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L65) + +*** + +### thumb\_url? + +```ts +optional thumb_url: string; +``` + +#### Description + +A valid URL to an image file that will be displayed as a thumbnail on the right side of +a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. +The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. +The file size of the image must also be less than 500 KB. +For best results, please use images that are already 75px by 75px. + +#### Defined in + +[message-attachments.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L86) + +*** + +### title? + +```ts +optional title: string; +``` + +#### Description + +Large title text near the top of the attachment. + +#### Defined in + +[message-attachments.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L54) + +*** + +### title\_link? + +```ts +optional title_link: string; +``` + +#### Description + +A valid URL that turns the `title` text into a hyperlink. + +#### Defined in + +[message-attachments.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L58) + +*** + +### ts? + +```ts +optional ts: string; +``` + +#### Description + +A Unix timestamp that is used to relate your attachment to a specific time. +The attachment will display the additional timestamp value as part of the attachment's footer. +Your message's timestamp will be displayed in varying ways, depending on how far in the past or future it is, +relative to the present. Form factors, like mobile versus desktop may also transform its rendered appearance. + +#### Defined in + +[message-attachments.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L104) diff --git a/docs/content/reference/types/interfaces/MessageAttachmentField.md b/docs/content/reference/types/interfaces/MessageAttachmentField.md new file mode 100644 index 000000000..64fd7e461 --- /dev/null +++ b/docs/content/reference/types/interfaces/MessageAttachmentField.md @@ -0,0 +1,59 @@ +# Interface: MessageAttachmentField + +## Description + +A field object to include in a [MessageAttachment](MessageAttachment.md). + +## See + +[Field objects reference](https://api.slack.com/reference/messaging/attachments#field_objects). + +## Properties + +### short? + +```ts +optional short: boolean; +``` + +#### Description + +Indicates whether the field object is short enough to be displayed side-by-side with +other field objects. Defaults to `false`. + +#### Defined in + +[message-attachments.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L138) + +*** + +### title + +```ts +title: string; +``` + +#### Description + +Shown as a bold heading displayed in the field object. It cannot contain markup and +will be escaped for you. + +#### Defined in + +[message-attachments.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L129) + +*** + +### value + +```ts +value: string; +``` + +#### Description + +The text value displayed in the field object. It can be formatted as plain text, or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by using the `mrkdwn_in` option of [MessageAttachment](MessageAttachment.md). + +#### Defined in + +[message-attachments.ts:133](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L133) diff --git a/docs/content/reference/types/interfaces/MessageMetadata.md b/docs/content/reference/types/interfaces/MessageMetadata.md new file mode 100644 index 000000000..26a7a902b --- /dev/null +++ b/docs/content/reference/types/interfaces/MessageMetadata.md @@ -0,0 +1,52 @@ +# Interface: MessageMetadata + +## Description + +Application-specific data to attach to Slack message. + +## See + + - [Using Metadata](https://api.slack.com/metadata/using) + - [Metadata Payload Structure](https://api.slack.com/reference/metadata#payload_structure) + +## Properties + +### event\_payload + +```ts +event_payload: object; +``` + +#### Index Signature + + \[`key`: `string`\]: + \| `string` + \| `number` + \| `boolean` + \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md) + \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md)[] + +#### Description + +A free-form object containing whatever data your application wishes to attach to messages. + +#### Defined in + +[message-metadata.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L15) + +*** + +### event\_type + +```ts +event_type: string; +``` + +#### Description + +A human readable alphanumeric string representing your application's metadata event. +The value of this field may appear in the UI to developers. + +#### Defined in + +[message-metadata.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L11) diff --git a/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md b/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md new file mode 100644 index 000000000..fa6b94c30 --- /dev/null +++ b/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md @@ -0,0 +1,5 @@ +# Interface: MessageMetadataEventPayloadObject + +## Indexable + + \[`key`: `string`\]: `string` \| `number` \| `boolean` diff --git a/docs/content/reference/types/interfaces/ModalView.md b/docs/content/reference/types/interfaces/ModalView.md new file mode 100644 index 000000000..99053f1ad --- /dev/null +++ b/docs/content/reference/types/interfaces/ModalView.md @@ -0,0 +1,196 @@ +# Interface: ModalView + +## Extends + +- `BaseView` + +## Properties + +### blocks + +```ts +blocks: AnyBlock[]; +``` + +#### Description + +An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. + +#### Inherited from + +`BaseView.blocks` + +#### Defined in + +[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Description + +An identifier to recognize interactions and submissions of this particular view. Don't use this to +store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. + +#### See + +[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). + +#### Inherited from + +`BaseView.callback_id` + +#### Defined in + +[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) + +*** + +### clear\_on\_close? + +```ts +optional clear_on_close: boolean; +``` + +#### Description + +When set to `true`, clicking on the close button will clear all views in a modal and close it. +Defaults to `false`. + +#### Defined in + +[views.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L54) + +*** + +### close? + +```ts +optional close: PlainTextElement; +``` + +#### Description + +An optional [PlainTextElement](PlainTextElement.md) that defines the text displayed in the close button at the +bottom-right of the view. Maximum length of 24 characters. + +#### Defined in + +[views.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L43) + +*** + +### external\_id? + +```ts +optional external_id: string; +``` + +#### Description + +A custom identifier that must be unique for all views on a per-team basis. + +#### Inherited from + +`BaseView.external_id` + +#### Defined in + +[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) + +*** + +### notify\_on\_close? + +```ts +optional notify_on_close: boolean; +``` + +#### Description + +Indicates whether Slack will send your app a +[`view_closed`](https://api.slack.com/reference/interaction-payloads/views#view_closed) event when a user +clicks the close button. Defaults to `false`. + +#### Defined in + +[views.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L60) + +*** + +### private\_metadata? + +```ts +optional private_metadata: string; +``` + +#### Description + +String that will be sent to your app in +[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and +[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. +Maximum length of 3000 characters. + +#### Inherited from + +`BaseView.private_metadata` + +#### Defined in + +[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) + +*** + +### submit? + +```ts +optional submit: PlainTextElement; +``` + +#### Description + +An optional [PlainTextElement](PlainTextElement.md) that defines the text displayed in the submit button at the +bottom-right of the view. `submit` is required when an input block is within the `blocks` array. Max length of 24 +characters. + +#### Defined in + +[views.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L49) + +*** + +### title + +```ts +title: PlainTextElement; +``` + +#### Description + +The title that appears in the top-left of the modal. Must be a [PlainTextElement](PlainTextElement.md) with a +maximum length of 24 characters. + +#### Defined in + +[views.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L38) + +*** + +### type + +```ts +type: "modal"; +``` + +#### Description + +The type of view. Set to `modal` for modals. + +#### Defined in + +[views.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L33) diff --git a/docs/content/reference/types/interfaces/MrkdwnElement.md b/docs/content/reference/types/interfaces/MrkdwnElement.md new file mode 100644 index 000000000..4b90e8608 --- /dev/null +++ b/docs/content/reference/types/interfaces/MrkdwnElement.md @@ -0,0 +1,61 @@ +# Interface: MrkdwnElement + +## Description + +Defines an object containing some text. + +## See + +[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). + +## Properties + +### text + +```ts +text: string; +``` + +#### Description + +The text for the block. This field accepts any of the standard text formatting markup. +The minimum length is 1 and maximum length is 3000 characters. + +#### Defined in + +[block-kit/composition-objects.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L166) + +*** + +### type + +```ts +type: "mrkdwn"; +``` + +#### Description + +The formatting to use for this text object. + +#### Defined in + +[block-kit/composition-objects.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L161) + +*** + +### verbatim? + +```ts +optional verbatim: boolean; +``` + +#### Description + +When set to `false` (as is default) URLs will be auto-converted into links, conversation names will +be link-ified, and certain mentions will be [automatically parsed](https://api.slack.com/reference/surfaces/formatting#automatic-parsing). +Using a value of `true` will skip any preprocessing of this nature, although you can still include +[manual parsing strings](https://api.slack.com/reference/surfaces/formatting#advanced). + +#### Defined in + +[block-kit/composition-objects.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L173) diff --git a/docs/content/reference/types/interfaces/MrkdwnOption.md b/docs/content/reference/types/interfaces/MrkdwnOption.md new file mode 100644 index 000000000..ab6216f66 --- /dev/null +++ b/docs/content/reference/types/interfaces/MrkdwnOption.md @@ -0,0 +1,85 @@ +# Interface: MrkdwnOption + +## Extends + +- `OptionDescriptor` + +## Properties + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. +Maximum length for the `text` within this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.description` + +#### Defined in + +[block-kit/composition-objects.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L85) + +*** + +### text + +```ts +text: MrkdwnElement; +``` + +#### Description + +A [MrkdwnElement](MrkdwnElement.md) that defines the text shown in the option on the menu. To be used with +radio buttons and checkboxes. Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +[block-kit/composition-objects.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L93) + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +Only available in overflow menus! A URL to load in the user's browser when the option is clicked. +Maximum length for this field is 3000 characters. + +#### Inherited from + +`OptionDescriptor.url` + +#### Defined in + +[block-kit/composition-objects.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L80) + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +A unique string value that will be passed to your app when this option is chosen. +Maximum length for this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.value` + +#### Defined in + +[block-kit/composition-objects.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L75) diff --git a/docs/content/reference/types/interfaces/MultiChannelsSelect.md b/docs/content/reference/types/interfaces/MultiChannelsSelect.md new file mode 100644 index 000000000..3d393347e --- /dev/null +++ b/docs/content/reference/types/interfaces/MultiChannelsSelect.md @@ -0,0 +1,155 @@ +# Interface: MultiChannelsSelect + +## Description + +This multi-select menu will populate its options with a list of public channels visible to the current +user in the active workspace. + +## See + + - [Multi-select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channel_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_channels? + +```ts +optional initial_channels: string[]; +``` + +#### Description + +An array of one or more IDs of any valid public channel to be pre-selected when the menu loads. + +#### Defined in + +[block-kit/block-elements.ts:471](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L471) + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Inherited from + +[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "multi_channels_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_channels_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L466) diff --git a/docs/content/reference/types/interfaces/MultiConversationsSelect.md b/docs/content/reference/types/interfaces/MultiConversationsSelect.md new file mode 100644 index 000000000..e2286c567 --- /dev/null +++ b/docs/content/reference/types/interfaces/MultiConversationsSelect.md @@ -0,0 +1,207 @@ +# Interface: MultiConversationsSelect + +## Description + +This multi-select menu will populate its options with a list of public and private channels, DMs, and +MPIMs visible to the current user in the active workspace. + +## See + + - [Multi-select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### default\_to\_current\_conversation? + +```ts +optional default_to_current_conversation: boolean; +``` + +#### Description + +Pre-populates the select menu with the conversation that the user was viewing when they opened the +modal, if available. Default is `false`. + +#### Defined in + +[block-kit/block-elements.ts:417](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L417) + +*** + +### filter? + +```ts +optional filter: object; +``` + +#### exclude\_bot\_users? + +```ts +optional exclude_bot_users: boolean; +``` + +#### exclude\_external\_shared\_channels? + +```ts +optional exclude_external_shared_channels: boolean; +``` + +#### include? + +```ts +optional include: ("im" | "mpim" | "private" | "public")[]; +``` + +#### Description + +A filter object that reduces the list of available conversations using the specified criteria. + +#### Defined in + +[block-kit/block-elements.ts:421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L421) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_conversations? + +```ts +optional initial_conversations: string[]; +``` + +#### Description + +An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If +`default_to_current_conversation` is also supplied, `initial_conversation` will be ignored. + +#### Defined in + +[block-kit/block-elements.ts:412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L412) + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Inherited from + +[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "multi_conversations_select"; +``` + +#### Description + +The type of element. In this case `type` is always `conversations_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:406](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L406) diff --git a/docs/content/reference/types/interfaces/MultiExternalSelect.md b/docs/content/reference/types/interfaces/MultiExternalSelect.md new file mode 100644 index 000000000..9872bc56f --- /dev/null +++ b/docs/content/reference/types/interfaces/MultiExternalSelect.md @@ -0,0 +1,172 @@ +# Interface: MultiExternalSelect + +## Description + +This menu will load its options from an external data source, allowing for a dynamic list of options. + +## See + + - [Multi-select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_options? + +```ts +optional initial_options: PlainTextOption[]; +``` + +#### Description + +An array of options to be selected when the menu initially loads. + +#### Defined in + +[block-kit/block-elements.ts:521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L521) + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Inherited from + +[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) + +*** + +### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### Description + +When the typeahead field is used, a request will be sent on every character change. If you prefer +fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number +of typed characters required before dispatch. The default value is `3`. + +#### Defined in + +[block-kit/block-elements.ts:527](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L527) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "multi_external_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_external_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:516](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L516) diff --git a/docs/content/reference/types/interfaces/MultiStaticSelect.md b/docs/content/reference/types/interfaces/MultiStaticSelect.md new file mode 100644 index 000000000..a073f7189 --- /dev/null +++ b/docs/content/reference/types/interfaces/MultiStaticSelect.md @@ -0,0 +1,190 @@ +# Interface: MultiStaticSelect + +## Description + +This is the simplest form of select menu, with a static list of options passed in when defining the +element. + +## See + + - [Multi-select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_options? + +```ts +optional initial_options: PlainTextOption[]; +``` + +#### Description + +An array of option objects that exactly match one or more of the options within `options` or +`option_groups`. These options will be selected when the menu initially loads. + +#### Defined in + +[block-kit/block-elements.ts:331](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L331) + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Inherited from + +[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) + +*** + +### option\_groups? + +```ts +optional option_groups: object[]; +``` + +#### Description + +An array of option group objects. Maximum number of option groups is 100. If `options` is specified, +this field should not be. + +#### Defined in + +[block-kit/block-elements.ts:346](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L346) + +*** + +### options? + +```ts +optional options: PlainTextOption[]; +``` + +#### Description + +An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is +specified, this field should not be. + +#### Defined in + +[block-kit/block-elements.ts:338](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L338) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "multi_static_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_static_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:325](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L325) diff --git a/docs/content/reference/types/interfaces/MultiUsersSelect.md b/docs/content/reference/types/interfaces/MultiUsersSelect.md new file mode 100644 index 000000000..3bb63f9b9 --- /dev/null +++ b/docs/content/reference/types/interfaces/MultiUsersSelect.md @@ -0,0 +1,155 @@ +# Interface: MultiUsersSelect + +## Description + +This multi-select menu will populate its options with a list of Slack users visible to the current user +in the active workspace. + +## See + + - [Multi-select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_users? + +```ts +optional initial_users: string[]; +``` + +#### Description + +An array of user IDs of any valid users to be pre-selected when the menu loads. + +#### Defined in + +[block-kit/block-elements.ts:266](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L266) + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected. Minimum number is 1. + +#### Inherited from + +[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) + +#### Defined in + +[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "multi_users_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_users_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:262](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L262) diff --git a/docs/content/reference/types/interfaces/NumberInput.md b/docs/content/reference/types/interfaces/NumberInput.md new file mode 100644 index 000000000..c7eea927f --- /dev/null +++ b/docs/content/reference/types/interfaces/NumberInput.md @@ -0,0 +1,184 @@ +# Interface: NumberInput + +## Description + +Allows user to enter a number into a single-line field. The number input element accepts both whole and +decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Decimal numbers are only allowed when +`is_decimal_allowed` is equal to `true`. + +## See + + - [Number input element reference](https://api.slack.com/reference/block-kit/block-elements#number). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the input when it is loaded. + +#### Defined in + +[block-kit/block-elements.ts:557](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L557) + +*** + +### is\_decimal\_allowed + +```ts +is_decimal_allowed: boolean; +``` + +#### Description + +Decimal numbers are allowed if this property is `true`, set the value to `false` otherwise. + +#### Defined in + +[block-kit/block-elements.ts:553](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L553) + +*** + +### max\_value? + +```ts +optional max_value: string; +``` + +#### Description + +The maximum value, cannot be less than `min_value`. + +#### Defined in + +[block-kit/block-elements.ts:565](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L565) + +*** + +### min\_value? + +```ts +optional min_value: string; +``` + +#### Description + +The minimum value, cannot be greater than `max_value`. + +#### Defined in + +[block-kit/block-elements.ts:561](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L561) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "number_input"; +``` + +#### Description + +The type of element. In this case `type` is always `number_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:549](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L549) diff --git a/docs/content/reference/types/interfaces/OptionGroup.md b/docs/content/reference/types/interfaces/OptionGroup.md new file mode 100644 index 000000000..11b2ce3fb --- /dev/null +++ b/docs/content/reference/types/interfaces/OptionGroup.md @@ -0,0 +1,42 @@ +# Interface: OptionGroup + +## Description + +Defines a way to group options in a select or multi-select menu. + +## See + +[Option group object reference](https://api.slack.com/reference/block-kit/composition-objects#option_group). + +## Properties + +### label + +```ts +label: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the label shown above this group of options. +Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +[block-kit/composition-objects.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L120) + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) that belong to this specific group. Maximum of 100 items. + +#### Defined in + +[block-kit/composition-objects.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L124) diff --git a/docs/content/reference/types/interfaces/Overflow.md b/docs/content/reference/types/interfaces/Overflow.md new file mode 100644 index 000000000..21ac78054 --- /dev/null +++ b/docs/content/reference/types/interfaces/Overflow.md @@ -0,0 +1,95 @@ +# Interface: Overflow + +## Description + +Allows users to press a button to view a list of options. +Unlike the select menu, there is no typeahead field, and the button always appears with an ellipsis ('…') rather +than customizable text. As such, it is usually used if you want a more compact layout than a select menu, or to +supply a list of less visually important actions after a row of buttons. You can also specify simple URL links as +overflow menu options, instead of actions. + +## See + + - [Overflow menu element reference](https://api.slack.com/reference/block-kit/block-elements#overflow). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### options + +```ts +options: PlainTextOption[]; +``` + +#### Description + +An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu. + +#### Defined in + +[block-kit/block-elements.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L586) + +*** + +### type + +```ts +type: "overflow"; +``` + +#### Description + +The type of element. In this case `type` is always `number_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:581](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L581) diff --git a/docs/content/reference/types/interfaces/Placeholdable.md b/docs/content/reference/types/interfaces/Placeholdable.md new file mode 100644 index 000000000..a00cfc058 --- /dev/null +++ b/docs/content/reference/types/interfaces/Placeholdable.md @@ -0,0 +1,38 @@ +# Interface: Placeholdable + +## Extended by + +- [`Datepicker`](Datepicker.md) +- [`EmailInput`](EmailInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) diff --git a/docs/content/reference/types/interfaces/PlainTextElement.md b/docs/content/reference/types/interfaces/PlainTextElement.md new file mode 100644 index 000000000..70892b4f3 --- /dev/null +++ b/docs/content/reference/types/interfaces/PlainTextElement.md @@ -0,0 +1,57 @@ +# Interface: PlainTextElement + +## Description + +Defines an object containing some text. + +## See + +[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). + +## Properties + +### emoji? + +```ts +optional emoji: boolean; +``` + +#### Description + +Indicates whether emojis in a text field should be escaped into the colon emoji format. + +#### Defined in + +[block-kit/composition-objects.ts:150](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L150) + +*** + +### text + +```ts +text: string; +``` + +#### Description + +The text for the block. The minimum length is 1 and maximum length is 3000 characters. + +#### Defined in + +[block-kit/composition-objects.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L146) + +*** + +### type + +```ts +type: "plain_text"; +``` + +#### Description + +The formatting to use for this text object. + +#### Defined in + +[block-kit/composition-objects.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L142) diff --git a/docs/content/reference/types/interfaces/PlainTextInput.md b/docs/content/reference/types/interfaces/PlainTextInput.md new file mode 100644 index 000000000..e8c6db86c --- /dev/null +++ b/docs/content/reference/types/interfaces/PlainTextInput.md @@ -0,0 +1,185 @@ +# Interface: PlainTextInput + +## Description + +Allows users to enter freeform text data into a single-line or multi-line field. + +## See + + - [Plain-text input element reference](https://api.slack.com/reference/block-kit/block-elements#input). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the plain-text input when it is loaded. + +#### Defined in + +[block-kit/block-elements.ts:606](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L606) + +*** + +### max\_length? + +```ts +optional max_length: number; +``` + +#### Description + +The maximum length of input that the user can provide. If the user provides more, +they will receive an error. + +#### Defined in + +[block-kit/block-elements.ts:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L621) + +*** + +### min\_length? + +```ts +optional min_length: number; +``` + +#### Description + +The minimum length of input that the user must provide. If the user provides less, they will receive +an error. Maximum value is 3000. + +#### Defined in + +[block-kit/block-elements.ts:616](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L616) + +*** + +### multiline? + +```ts +optional multiline: boolean; +``` + +#### Description + +Indicates whether the input will be a single line (`false`) or a larger textarea (`true`). +Defaults to `false`. + +#### Defined in + +[block-kit/block-elements.ts:611](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L611) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "plain_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `plain_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:602](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L602) diff --git a/docs/content/reference/types/interfaces/PlainTextOption.md b/docs/content/reference/types/interfaces/PlainTextOption.md new file mode 100644 index 000000000..ecc70d12c --- /dev/null +++ b/docs/content/reference/types/interfaces/PlainTextOption.md @@ -0,0 +1,85 @@ +# Interface: PlainTextOption + +## Extends + +- `OptionDescriptor` + +## Properties + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. +Maximum length for the `text` within this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.description` + +#### Defined in + +[block-kit/composition-objects.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L85) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the text shown in the option on the menu. To be used with +overflow, select and multi-select menus. Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +[block-kit/composition-objects.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L101) + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +Only available in overflow menus! A URL to load in the user's browser when the option is clicked. +Maximum length for this field is 3000 characters. + +#### Inherited from + +`OptionDescriptor.url` + +#### Defined in + +[block-kit/composition-objects.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L80) + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +A unique string value that will be passed to your app when this option is chosen. +Maximum length for this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.value` + +#### Defined in + +[block-kit/composition-objects.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L75) diff --git a/docs/content/reference/types/interfaces/RadioButtons.md b/docs/content/reference/types/interfaces/RadioButtons.md new file mode 100644 index 000000000..97337de49 --- /dev/null +++ b/docs/content/reference/types/interfaces/RadioButtons.md @@ -0,0 +1,130 @@ +# Interface: RadioButtons + +## Description + +Allows users to choose one item from a list of possible options. + +## See + + - [Radio button group element reference](https://api.slack.com/reference/block-kit/block-elements#radio). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_option? + +```ts +optional initial_option: Option; +``` + +#### Description + +An [Option](../type-aliases/Option.md) object that exactly matches one of the options within `options`. This option will +be selected when the radio button group initially loads. + +#### Defined in + +[block-kit/block-elements.ts:638](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L638) + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. + +#### Defined in + +[block-kit/block-elements.ts:642](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L642) + +*** + +### type + +```ts +type: "radio_buttons"; +``` + +#### Description + +The type of element. In this case `type` is always `radio_buttons`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:633](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L633) diff --git a/docs/content/reference/types/interfaces/RichTextBlock.md b/docs/content/reference/types/interfaces/RichTextBlock.md new file mode 100644 index 000000000..efa0149cb --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextBlock.md @@ -0,0 +1,74 @@ +# Interface: RichTextBlock + +## Description + +Displays formatted, structured representation of text. It is also the output of the Slack client's +WYSIWYG message composer, so all messages sent by end-users will have this format. Use this block to include +user-defined formatted text in your Block Kit payload. While it is possible to format text with `mrkdwn`, +`rich_text` is strongly preferred and allows greater flexibility. +You might encounter a `rich_text` block in a message payload, as a built-in type in workflow apps, or as output of +the [RichTextInput](RichTextInput.md). + +## See + +[Rich text block reference](https://api.slack.com/reference/block-kit/blocks#rich_text). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### elements + +```ts +elements: RichTextBlockElement[]; +``` + +#### Defined in + +[block-kit/blocks.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L241) + +*** + +### type + +```ts +type: "rich_text"; +``` + +#### Description + +The type of block. For a rich text block, `type` is always `rich_text`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L240) diff --git a/docs/content/reference/types/interfaces/RichTextBorderable.md b/docs/content/reference/types/interfaces/RichTextBorderable.md new file mode 100644 index 000000000..835f7cec9 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextBorderable.md @@ -0,0 +1,26 @@ +# Interface: RichTextBorderable + +For use in setting border style details on certain Rich Text elements. + +## Extended by + +- [`RichTextList`](RichTextList.md) +- [`RichTextQuote`](RichTextQuote.md) +- [`RichTextPreformatted`](RichTextPreformatted.md) + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the list. `0` renders no border +while `1` renders a border. + +#### Defined in + +[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) diff --git a/docs/content/reference/types/interfaces/RichTextBroadcastMention.md b/docs/content/reference/types/interfaces/RichTextBroadcastMention.md new file mode 100644 index 000000000..109544c31 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextBroadcastMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextBroadcastMention + +## Description + +A broadcast mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### range + +```ts +range: "here" | "channel" | "everyone"; +``` + +#### Description + +The range of the broadcast; can be one of `here`, `channel` and `everyone`. + +#### Defined in + +[block-kit/block-elements.ts:766](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L766) + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "broadcast"; +``` + +#### Description + +The type of element. In this case `type` is always `broadcast`. + +#### Defined in + +[block-kit/block-elements.ts:762](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L762) diff --git a/docs/content/reference/types/interfaces/RichTextChannelMention.md b/docs/content/reference/types/interfaces/RichTextChannelMention.md new file mode 100644 index 000000000..2cf45b6b1 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextChannelMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextChannelMention + +## Description + +A channel mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +The encoded channel ID, e.g. C1234ABCD. + +#### Defined in + +[block-kit/block-elements.ts:794](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L794) + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "channel"; +``` + +#### Description + +The type of element. In this case `type` is always `channel`. + +#### Defined in + +[block-kit/block-elements.ts:790](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L790) diff --git a/docs/content/reference/types/interfaces/RichTextColor.md b/docs/content/reference/types/interfaces/RichTextColor.md new file mode 100644 index 000000000..993d3930d --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextColor.md @@ -0,0 +1,101 @@ +# Interface: RichTextColor + +## Description + +A hex color element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "color"; +``` + +#### Description + +The type of element. In this case `type` is always `color`. + +#### Defined in + +[block-kit/block-elements.ts:776](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L776) + +*** + +### value + +```ts +value: string; +``` + +#### Description + +The hex value for the color. + +#### Defined in + +[block-kit/block-elements.ts:780](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L780) diff --git a/docs/content/reference/types/interfaces/RichTextDate.md b/docs/content/reference/types/interfaces/RichTextDate.md new file mode 100644 index 000000000..1fbdde726 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextDate.md @@ -0,0 +1,169 @@ +# Interface: RichTextDate + +## Description + +A date element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### fallback? + +```ts +optional fallback: string; +``` + +#### Description + +Text to display in place of the date should parsing, formatting or displaying fails. + +#### Defined in + +[block-kit/block-elements.ts:840](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L840) + +*** + +### format + +```ts +format: string; +``` + +#### Description + +A template string containing curly-brace-enclosed tokens to substitute your provided `timestamp` +in a particularly-formatted way. For example: `Posted at {date_long}`. The available date formatting tokens are: +- `{day_divider_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable. Otherwise, if the date is in + current year, uses the `{date_long}` format without the year. Otherwise, falls back to using the `{date_long}` + format. +- `{date_num}`: Shows date as YYYY-MM-DD. +- `{date_slash}`: Shows date as DD/MM/YYYY (subject to locale preferences). +- `{date_long}`: Shows date as a long-form sentence including day-of-week, e.g. `Monday, December 23rd, 2013`. +- `{date_long_full}`: Shows date as a long-form sentence without day-of-week, e.g. `August 9, 2020`. +- `{date_long_pretty}`: Shows `yesterday`, `today` or `tomorrow`, otherwise uses the `{date_long}` format. +- `{date}`: Same as `{date_long_full}` but without the year. +- `{date_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date}` format. +- `{date_short}`: Shows date using short month names without day-of-week, e.g. `Aug 9, 2020`. +- `{date_short_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date_short}` + format. +- `{time}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 or + 24 hour clock formats, e.g. `2:34 PM` or `14:34`. +- `{time_secs}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 + or 24 hour clock formats, including seconds, e.g. `2:34:56 PM` or `14:34:56`. +- `{ago}`: A human-readable period of time, e.g. `3 minutes ago`, `4 hours ago`, `2 days ago`. +TODO: test/document `{member_local_time}`, `{status_expiration}` and `{calendar_header}` + +#### Defined in + +[block-kit/block-elements.ts:832](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L832) + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### timestamp + +```ts +timestamp: number; +``` + +#### Description + +A UNIX timestamp for the date to be displayed in seconds. + +#### Defined in + +[block-kit/block-elements.ts:808](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L808) + +*** + +### type + +```ts +type: "date"; +``` + +#### Description + +The type of element. In this case `type` is always `date`. + +#### Defined in + +[block-kit/block-elements.ts:804](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L804) + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +URL to link the entire `format` string to. + +#### Defined in + +[block-kit/block-elements.ts:836](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L836) diff --git a/docs/content/reference/types/interfaces/RichTextEmoji.md b/docs/content/reference/types/interfaces/RichTextEmoji.md new file mode 100644 index 000000000..d514b4db9 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextEmoji.md @@ -0,0 +1,133 @@ +# Interface: RichTextEmoji + +## Description + +An emoji element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +Name of emoji, without colons or skin tones, e.g. `wave` + +#### Defined in + +[block-kit/block-elements.ts:854](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L854) + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "emoji"; +``` + +#### Description + +The type of element. In this case `type` is always `emoji`. + +#### Defined in + +[block-kit/block-elements.ts:850](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L850) + +*** + +### unicode? + +```ts +optional unicode: string; +``` + +#### Description + +Lowercase hexadecimal Unicode representation of a standard emoji (not for use with custom emoji). + +#### Defined in + +[block-kit/block-elements.ts:858](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L858) + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +URL of emoji asset. Only used when sharing custom emoji across workspaces. + +#### Defined in + +[block-kit/block-elements.ts:862](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L862) diff --git a/docs/content/reference/types/interfaces/RichTextInput.md b/docs/content/reference/types/interfaces/RichTextInput.md new file mode 100644 index 000000000..c200dac14 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextInput.md @@ -0,0 +1,135 @@ +# Interface: RichTextInput + +## Description + +A rich text input creates a composer/WYSIWYG editor for entering formatted text, offering nearly the +same experience you have writing messages in Slack. + +## See + + - [Rich-text input element reference](https://api.slack.com/reference/block-kit/block-elements#rich_text_input). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_value? + +```ts +optional initial_value: RichTextBlock; +``` + +#### Description + +Initial contents of the input when it is loaded. + +#### Defined in + +[block-kit/block-elements.ts:1039](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1039) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "rich_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:1035](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1035) diff --git a/docs/content/reference/types/interfaces/RichTextLink.md b/docs/content/reference/types/interfaces/RichTextLink.md new file mode 100644 index 000000000..14b8b96aa --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextLink.md @@ -0,0 +1,133 @@ +# Interface: RichTextLink + +## Description + +A link element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### text? + +```ts +optional text: string; +``` + +#### Description + +The text to link. + +#### Defined in + +[block-kit/block-elements.ts:876](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L876) + +*** + +### type + +```ts +type: "link"; +``` + +#### Description + +The type of element. In this case `type` is always `link`. + +#### Defined in + +[block-kit/block-elements.ts:872](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L872) + +*** + +### unsafe? + +```ts +optional unsafe: boolean; +``` + +#### Description + +TODO: ? + +#### Defined in + +[block-kit/block-elements.ts:880](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L880) + +*** + +### url + +```ts +url: string; +``` + +#### Description + +URL to link to. + +#### Defined in + +[block-kit/block-elements.ts:884](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L884) diff --git a/docs/content/reference/types/interfaces/RichTextList.md b/docs/content/reference/types/interfaces/RichTextList.md new file mode 100644 index 000000000..a88882d2a --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextList.md @@ -0,0 +1,96 @@ +# Interface: RichTextList + +## Description + +A list block within a rich text field. + +## Extends + +- [`RichTextBorderable`](RichTextBorderable.md) + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the list. `0` renders no border +while `1` renders a border. + +#### Inherited from + +[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) + +#### Defined in + +[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) + +*** + +### elements + +```ts +elements: RichTextSection[]; +``` + +#### Description + +An array of [RichTextSection](RichTextSection.md) elements comprising each list item. + +#### Defined in + +[block-kit/block-elements.ts:980](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L980) + +*** + +### indent? + +```ts +optional indent: number; +``` + +#### Description + +The style of the list points. Can be a number from `0` (default) to `8`. Yields a different character +or characters rendered as the list points. Also affected by the `style` property. + +#### Defined in + +[block-kit/block-elements.ts:990](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L990) + +*** + +### style + +```ts +style: "bullet" | "ordered"; +``` + +#### Description + +The type of list. Can be either `bullet` (the list points are all rendered the same way) or `ordered` +(the list points increase numerically from 1). + +#### Defined in + +[block-kit/block-elements.ts:985](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L985) + +*** + +### type + +```ts +type: "rich_text_list"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_list`. + +#### Defined in + +[block-kit/block-elements.ts:976](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L976) diff --git a/docs/content/reference/types/interfaces/RichTextPreformatted.md b/docs/content/reference/types/interfaces/RichTextPreformatted.md new file mode 100644 index 000000000..e191e4b4a --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextPreformatted.md @@ -0,0 +1,62 @@ +# Interface: RichTextPreformatted + +## Description + +A block of preformatted text within a rich text field. + +## Extends + +- [`RichTextBorderable`](RichTextBorderable.md) + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the list. `0` renders no border +while `1` renders a border. + +#### Inherited from + +[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) + +#### Defined in + +[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) + +*** + +### elements + +```ts +elements: (RichTextLink | RichTextText)[]; +``` + +#### Description + +An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextText.md) comprising the preformatted text. + +#### Defined in + +[block-kit/block-elements.ts:1018](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1018) + +*** + +### type + +```ts +type: "rich_text_preformatted"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_preformatted`. + +#### Defined in + +[block-kit/block-elements.ts:1014](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1014) diff --git a/docs/content/reference/types/interfaces/RichTextQuote.md b/docs/content/reference/types/interfaces/RichTextQuote.md new file mode 100644 index 000000000..2826392f8 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextQuote.md @@ -0,0 +1,62 @@ +# Interface: RichTextQuote + +## Description + +A quote block within a rich text field. + +## Extends + +- [`RichTextBorderable`](RichTextBorderable.md) + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the list. `0` renders no border +while `1` renders a border. + +#### Inherited from + +[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) + +#### Defined in + +[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) + +*** + +### elements + +```ts +elements: RichTextElement[]; +``` + +#### Description + +An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the quote block. + +#### Defined in + +[block-kit/block-elements.ts:1004](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1004) + +*** + +### type + +```ts +type: "rich_text_quote"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_quote`. + +#### Defined in + +[block-kit/block-elements.ts:1000](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1000) diff --git a/docs/content/reference/types/interfaces/RichTextSection.md b/docs/content/reference/types/interfaces/RichTextSection.md new file mode 100644 index 000000000..e91c88245 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextSection.md @@ -0,0 +1,33 @@ +# Interface: RichTextSection + +## Description + +A section block within a rich text field. + +## Properties + +### elements + +```ts +elements: RichTextElement[]; +``` + +#### Defined in + +[block-kit/block-elements.ts:966](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L966) + +*** + +### type + +```ts +type: "rich_text_section"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_section`. + +#### Defined in + +[block-kit/block-elements.ts:965](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L965) diff --git a/docs/content/reference/types/interfaces/RichTextStyleable.md b/docs/content/reference/types/interfaces/RichTextStyleable.md new file mode 100644 index 000000000..6187e75d1 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextStyleable.md @@ -0,0 +1,74 @@ +# Interface: RichTextStyleable + +## Description + +For use styling Rich Text sub-elements. + +## Extended by + +- [`RichTextBroadcastMention`](RichTextBroadcastMention.md) +- [`RichTextColor`](RichTextColor.md) +- [`RichTextChannelMention`](RichTextChannelMention.md) +- [`RichTextDate`](RichTextDate.md) +- [`RichTextEmoji`](RichTextEmoji.md) +- [`RichTextLink`](RichTextLink.md) +- [`RichTextTeamMention`](RichTextTeamMention.md) +- [`RichTextText`](RichTextText.md) +- [`RichTextUserMention`](RichTextUserMention.md) +- [`RichTextUsergroupMention`](RichTextUsergroupMention.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) diff --git a/docs/content/reference/types/interfaces/RichTextTeamMention.md b/docs/content/reference/types/interfaces/RichTextTeamMention.md new file mode 100644 index 000000000..7c267b5bd --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextTeamMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextTeamMention + +## Description + +A workspace or team mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID, e.g. T1234ABCD. + +#### Defined in + +[block-kit/block-elements.ts:898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L898) + +*** + +### type + +```ts +type: "team"; +``` + +#### Description + +The type of element. In this case `type` is always `team`. + +#### Defined in + +[block-kit/block-elements.ts:894](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L894) diff --git a/docs/content/reference/types/interfaces/RichTextText.md b/docs/content/reference/types/interfaces/RichTextText.md new file mode 100644 index 000000000..5bd3aa1c1 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextText.md @@ -0,0 +1,101 @@ +# Interface: RichTextText + +## Description + +A generic text element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### text + +```ts +text: string; +``` + +#### Description + +The text to render. + +#### Defined in + +[block-kit/block-elements.ts:912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L912) + +*** + +### type + +```ts +type: "text"; +``` + +#### Description + +The type of element. In this case `type` is always `text`. + +#### Defined in + +[block-kit/block-elements.ts:908](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L908) diff --git a/docs/content/reference/types/interfaces/RichTextUserMention.md b/docs/content/reference/types/interfaces/RichTextUserMention.md new file mode 100644 index 000000000..871730ca7 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextUserMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextUserMention + +## Description + +A user mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "user"; +``` + +#### Description + +The type of element. In this case `type` is always `user`. + +#### Defined in + +[block-kit/block-elements.ts:922](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L922) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The encoded user ID, e.g. U1234ABCD. + +#### Defined in + +[block-kit/block-elements.ts:926](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L926) diff --git a/docs/content/reference/types/interfaces/RichTextUsergroupMention.md b/docs/content/reference/types/interfaces/RichTextUsergroupMention.md new file mode 100644 index 000000000..9fb288be7 --- /dev/null +++ b/docs/content/reference/types/interfaces/RichTextUsergroupMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextUsergroupMention + +## Description + +A usergroup mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) + +*** + +### type + +```ts +type: "usergroup"; +``` + +#### Description + +The type of element. In this case `type` is always `usergroup`. + +#### Defined in + +[block-kit/block-elements.ts:936](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L936) + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +The encoded usergroup ID, e.g. S1234ABCD. + +#### Defined in + +[block-kit/block-elements.ts:940](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L940) diff --git a/docs/content/reference/types/interfaces/SectionBlock.md b/docs/content/reference/types/interfaces/SectionBlock.md new file mode 100644 index 000000000..c9450f139 --- /dev/null +++ b/docs/content/reference/types/interfaces/SectionBlock.md @@ -0,0 +1,112 @@ +# Interface: SectionBlock + +## Description + +Displays text, possibly alongside block elements. A section can be used as a simple text block, in +combination with text fields, or side-by-side with certain +[block elements](https://api.slack.com/reference/messaging/block-elements). + +## See + +[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### accessory? + +```ts +optional accessory: SectionBlockAccessory; +``` + +#### Description + +One of the compatible element objects. + +#### Defined in + +[block-kit/blocks.ts:280](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L280) + +*** + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### fields? + +```ts +optional fields: TextObject[]; +``` + +#### Description + +Required if no `text` is provided. An array of text objects. Any text objects included with `fields` +will be rendered in a compact format that allows for 2 columns of side-by-side text. Maximum number of items is 10. +Maximum length for the text in each item is 2000 characters. +[Click here for an example](https://app.slack.com/block-kit-builder/#%7B%22blocks%22:%5B%7B%22type%22:%22section%22,%22text%22:%7B%22text%22:%22A%20message%20*with%20some%20bold%20text*%20and%20_some%20italicized%20text_.%22,%22type%22:%22mrkdwn%22%7D,%22fields%22:%5B%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Priority*%22%7D,%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Type*%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22High%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22String%22%7D%5D%7D%5D%7D). + +#### Defined in + +[block-kit/blocks.ts:276](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L276) + +*** + +### text? + +```ts +optional text: TextObject; +``` + +#### Description + +The text for the block, in the form of a [TextObject](../type-aliases/TextObject.md). Minimum length for the `text` in this +field is 1 and maximum length is 3000 characters. This field is not required if a valid array of `fields` objects +is provided instead. + +#### Defined in + +[block-kit/blocks.ts:269](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L269) + +*** + +### type + +```ts +type: "section"; +``` + +#### Description + +The type of block. For a section block, `type` is always `section`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:263](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L263) diff --git a/docs/content/reference/types/interfaces/SelectOption.md b/docs/content/reference/types/interfaces/SelectOption.md new file mode 100644 index 000000000..5ca594dc7 --- /dev/null +++ b/docs/content/reference/types/interfaces/SelectOption.md @@ -0,0 +1,25 @@ +# Interface: SelectOption + +## Properties + +### label + +```ts +label: string; +``` + +#### Defined in + +[dialog.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L36) + +*** + +### value + +```ts +value: string; +``` + +#### Defined in + +[dialog.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L37) diff --git a/docs/content/reference/types/interfaces/SlackFileImageObject.md b/docs/content/reference/types/interfaces/SlackFileImageObject.md new file mode 100644 index 000000000..85ad463b6 --- /dev/null +++ b/docs/content/reference/types/interfaces/SlackFileImageObject.md @@ -0,0 +1,21 @@ +# Interface: SlackFileImageObject + +## Description + +Object for image which contains a slack_file. + +## Properties + +### slack\_file + +```ts +slack_file: SlackFile; +``` + +#### Description + +The slack file of the image to be displayed. + +#### Defined in + +[block-kit/composition-objects.ts:217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L217) diff --git a/docs/content/reference/types/interfaces/StaticSelect.md b/docs/content/reference/types/interfaces/StaticSelect.md new file mode 100644 index 000000000..20efaa05b --- /dev/null +++ b/docs/content/reference/types/interfaces/StaticSelect.md @@ -0,0 +1,170 @@ +# Interface: StaticSelect + +## Description + +This is the simplest form of select menu, with a static list of options passed in when defining the +element. + +## See + + - [Select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_option? + +```ts +optional initial_option: PlainTextOption; +``` + +#### Description + +A single option that exactly matches one of the options within `options` or `option_groups`. +This option will be selected when the menu initially loads. + +#### Defined in + +[block-kit/block-elements.ts:289](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L289) + +*** + +### option\_groups? + +```ts +optional option_groups: object[]; +``` + +#### Description + +An array of option group objects. Maximum number of option groups is 100. If `options` is specified, +this field should not be. + +#### Defined in + +[block-kit/block-elements.ts:304](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L304) + +*** + +### options? + +```ts +optional options: PlainTextOption[]; +``` + +#### Description + +An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is +specified, this field should not be. + +#### Defined in + +[block-kit/block-elements.ts:296](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L296) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "static_select"; +``` + +#### Description + +The type of element. In this case `type` is always `static_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L283) diff --git a/docs/content/reference/types/interfaces/Timepicker.md b/docs/content/reference/types/interfaces/Timepicker.md new file mode 100644 index 000000000..7c399dbf4 --- /dev/null +++ b/docs/content/reference/types/interfaces/Timepicker.md @@ -0,0 +1,155 @@ +# Interface: Timepicker + +## Description + +Allows users to choose a time from a rich dropdown UI. On desktop clients, this time picker will take +the form of a dropdown list with free-text entry for precise choices. On mobile clients, the time picker will use +native time picker UIs. + +## See + + - [Time picker element reference](https://api.slack.com/reference/block-kit/block-elements#timepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_time? + +```ts +optional initial_time: string; +``` + +#### Description + +The initial time that is selected when the element is loaded. This should be in the format `HH:mm`, +where `HH` is the 24-hour format of an hour (00 to 23) and `mm` is minutes with leading zeros (00 to 59), +for example 22:25 for 10:25pm. + +#### Defined in + +[block-kit/block-elements.ts:666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L666) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### timezone? + +```ts +optional timezone: string; +``` + +#### Description + +A string in the IANA format, e.g. 'America/Chicago'. The timezone is displayed to end users as hint +text underneath the time picker. It is also passed to the app upon certain interactions, such as view_submission. + +#### Defined in + +[block-kit/block-elements.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L671) + +*** + +### type + +```ts +type: "timepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `timepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:660](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L660) diff --git a/docs/content/reference/types/interfaces/URLInput.md b/docs/content/reference/types/interfaces/URLInput.md new file mode 100644 index 000000000..92be3d720 --- /dev/null +++ b/docs/content/reference/types/interfaces/URLInput.md @@ -0,0 +1,134 @@ +# Interface: URLInput + +## Description + +Allows user to enter a URL into a single-line field. + +## See + + - [URL input element reference](https://api.slack.com/reference/block-kit/block-elements#url). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the URL input when it is loaded. + +#### Defined in + +[block-kit/block-elements.ts:691](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L691) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "url_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `url_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L687) diff --git a/docs/content/reference/types/interfaces/URLRespondable.md b/docs/content/reference/types/interfaces/URLRespondable.md new file mode 100644 index 000000000..066a5eb50 --- /dev/null +++ b/docs/content/reference/types/interfaces/URLRespondable.md @@ -0,0 +1,25 @@ +# Interface: URLRespondable + +## Extended by + +- [`ConversationsSelect`](ConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) + +## Properties + +### response\_url\_enabled? + +```ts +optional response_url_enabled: boolean; +``` + +#### Description + +When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) +from the menu's parent view will contain a `response_url`. This `response_url` can be used for +[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation +for the message will be determined by the value of this select menu. + +#### Defined in + +[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) diff --git a/docs/content/reference/types/interfaces/UrlImageObject.md b/docs/content/reference/types/interfaces/UrlImageObject.md new file mode 100644 index 000000000..503baa03b --- /dev/null +++ b/docs/content/reference/types/interfaces/UrlImageObject.md @@ -0,0 +1,21 @@ +# Interface: UrlImageObject + +## Description + +Object for image which contains a image_url. + +## Properties + +### image\_url + +```ts +image_url: string; +``` + +#### Description + +The URL of the image to be displayed. + +#### Defined in + +[block-kit/composition-objects.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L207) diff --git a/docs/content/reference/types/interfaces/UsersSelect.md b/docs/content/reference/types/interfaces/UsersSelect.md new file mode 100644 index 000000000..2a4565247 --- /dev/null +++ b/docs/content/reference/types/interfaces/UsersSelect.md @@ -0,0 +1,135 @@ +# Interface: UsersSelect + +## Description + +This select menu will populate its options with a list of Slack users visible to the current user in the +active workspace. + +## See + + - [Select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) + +*** + +### initial\_user? + +```ts +optional initial_user: string; +``` + +#### Description + +The user ID of any valid user to be pre-selected when the menu loads. + +#### Defined in + +[block-kit/block-elements.ts:244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L244) + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) + +*** + +### type + +```ts +type: "users_select"; +``` + +#### Description + +The type of element. In this case `type` is always `users_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +[block-kit/block-elements.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L240) diff --git a/docs/content/reference/types/interfaces/VideoBlock.md b/docs/content/reference/types/interfaces/VideoBlock.md new file mode 100644 index 000000000..adff7cb4f --- /dev/null +++ b/docs/content/reference/types/interfaces/VideoBlock.md @@ -0,0 +1,206 @@ +# Interface: VideoBlock + +## Description + +Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g. +link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you +must have the [`links.embed:write` scope](https://api.slack.com/scopes/links.embed:write). + +## See + +[Video block reference](https://api.slack.com/reference/block-kit/blocks#video). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A tooltip for the video. Required for accessibility. + +#### Defined in + +[block-kit/blocks.ts:307](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L307) + +*** + +### author\_name? + +```ts +optional author_name: string; +``` + +#### Description + +Author name to be displayed. Must be less than 50 characters. + +#### Defined in + +[block-kit/blocks.ts:320](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L320) + +*** + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) + +*** + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +Description for video using a [PlainTextElement](PlainTextElement.md) object. + +#### Defined in + +[block-kit/blocks.ts:332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L332) + +*** + +### provider\_icon\_url? + +```ts +optional provider_icon_url: string; +``` + +#### Description + +Icon for the video provider, e.g. YouTube icon. + +#### Defined in + +[block-kit/blocks.ts:328](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L328) + +*** + +### provider\_name? + +```ts +optional provider_name: string; +``` + +#### Description + +The originating application or domain of the video, e.g. YouTube. + +#### Defined in + +[block-kit/blocks.ts:324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L324) + +*** + +### thumbnail\_url + +```ts +thumbnail_url: string; +``` + +#### Description + +The thumbnail image URL. + +#### Defined in + +[block-kit/blocks.ts:303](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L303) + +*** + +### title + +```ts +title: PlainTextElement; +``` + +#### Description + +Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within must be less than 200 characters. + +#### Defined in + +[block-kit/blocks.ts:311](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L311) + +*** + +### title\_url? + +```ts +optional title_url: string; +``` + +#### Description + +Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. +Must go to an HTTPS URL. + +#### Defined in + +[block-kit/blocks.ts:316](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L316) + +*** + +### type + +```ts +type: "video"; +``` + +#### Description + +The type of block. For a video block, `type` is always `video`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +[block-kit/blocks.ts:293](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L293) + +*** + +### video\_url + +```ts +video_url: string; +``` + +#### Description + +The URL to be embedded. Must match any existing +[unfurl domains](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains) within the app +and point to a HTTPS URL. + +#### Defined in + +[block-kit/blocks.ts:299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L299) diff --git a/docs/content/reference/types/interfaces/WorkflowButton.md b/docs/content/reference/types/interfaces/WorkflowButton.md new file mode 100644 index 000000000..a22d255e6 --- /dev/null +++ b/docs/content/reference/types/interfaces/WorkflowButton.md @@ -0,0 +1,153 @@ +# Interface: WorkflowButton + +## Description + +Allows users to run a [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) with customizable inputs. + +## See + +[Workflow button element reference](https://api.slack.com/reference/block-kit/block-elements#workflow_button). + +## Extends + +- [`Confirmable`](Confirmable.md) + +## Properties + +### accessibility\_label? + +```ts +optional accessibility_label: string; +``` + +#### Description + +A label for longer descriptive text about a button element. This label will be read out by screen +readers instead of the button `text` object. Maximum length for this field is 75 characters. + +#### Defined in + +[block-kit/block-elements.ts:752](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L752) + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) + +*** + +### style? + +```ts +optional style: ColorScheme; +``` + +#### Description + +Decorates buttons with alternative visual color schemes. Use this option with restraint. +`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should +only be used for one button within a set. +`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even +more sparingly than primary. +If you don't include this field, the default button style will be used. + +#### Defined in + +[block-kit/block-elements.ts:747](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L747) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. +Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +[block-kit/block-elements.ts:707](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L707) + +*** + +### type + +```ts +type: "workflow_button"; +``` + +#### Description + +The type of element. In this case `type` is always `workflow_button`. + +#### Defined in + +[block-kit/block-elements.ts:702](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L702) + +*** + +### workflow + +```ts +workflow: object; +``` + +#### trigger + +```ts +trigger: object; +``` + +##### Description + +Properties of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) +that will be invoked via this button. + +#### trigger.customizable\_input\_parameters? + +```ts +optional customizable_input_parameters: object[]; +``` + +##### Description + +List of customizable input parameters and their values. Should match input parameters specified on +the provided trigger. + +#### trigger.url + +```ts +url: string; +``` + +##### Description + +The trigger URL of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) + +#### Description + +A workflow object that contains details about the workflow that will run when the button is clicked. + +#### Defined in + +[block-kit/block-elements.ts:711](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L711) diff --git a/docs/content/reference/types/interfaces/WorkflowStepView.md b/docs/content/reference/types/interfaces/WorkflowStepView.md new file mode 100644 index 000000000..1c5d3487d --- /dev/null +++ b/docs/content/reference/types/interfaces/WorkflowStepView.md @@ -0,0 +1,128 @@ +# Interface: ~~WorkflowStepView~~ + +[Configuration modal](https://api.slack.com/legacy/workflows/steps#handle_config_view) for [legacy Workflow Steps from Apps](https://api.slack.com/legacy/workflows/steps). + +## Deprecated + +Steps from Apps are deprecated and will no longer be executed starting September 12, 2024. For more information, see our [deprecation announcement](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +## Extends + +- `BaseView` + +## Properties + +### ~~blocks~~ + +```ts +blocks: AnyBlock[]; +``` + +#### Description + +An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. + +#### Inherited from + +`BaseView.blocks` + +#### Defined in + +[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) + +*** + +### ~~callback\_id?~~ + +```ts +optional callback_id: string; +``` + +#### Description + +An identifier to recognize interactions and submissions of this particular view. Don't use this to +store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. + +#### See + +[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). + +#### Inherited from + +`BaseView.callback_id` + +#### Defined in + +[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) + +*** + +### ~~external\_id?~~ + +```ts +optional external_id: string; +``` + +#### Description + +A custom identifier that must be unique for all views on a per-team basis. + +#### Inherited from + +`BaseView.external_id` + +#### Defined in + +[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) + +*** + +### ~~private\_metadata?~~ + +```ts +optional private_metadata: string; +``` + +#### Description + +String that will be sent to your app in +[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and +[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. +Maximum length of 3000 characters. + +#### Inherited from + +`BaseView.private_metadata` + +#### Defined in + +[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) + +*** + +### ~~submit\_disabled?~~ + +```ts +optional submit_disabled: boolean; +``` + +#### Description + +When set to `true`, disables the submit button until the user has completed one or more inputs. +Defaults to `false`. + +#### Defined in + +[views.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L73) + +*** + +### ~~type~~ + +```ts +type: "workflow_step"; +``` + +#### Defined in + +[views.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L68) diff --git a/docs/content/reference/types/type-aliases/ActionsBlockElement.md b/docs/content/reference/types/type-aliases/ActionsBlockElement.md new file mode 100644 index 000000000..039ea4da6 --- /dev/null +++ b/docs/content/reference/types/type-aliases/ActionsBlockElement.md @@ -0,0 +1,26 @@ +# Type Alias: ActionsBlockElement + +```ts +type ActionsBlockElement: + | Button + | Checkboxes + | Datepicker + | DateTimepicker + | MultiSelect + | Overflow + | RadioButtons + | Select + | Timepicker + | WorkflowButton + | RichTextInput; +``` + +A helper union type of all Block Elements that can be used in an [ActionsBlock](../interfaces/ActionsBlock.md). + +## See + +[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). + +## Defined in + +[block-kit/blocks.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L64) diff --git a/docs/content/reference/types/type-aliases/AnyBlock.md b/docs/content/reference/types/type-aliases/AnyBlock.md new file mode 100644 index 000000000..9239eef3c --- /dev/null +++ b/docs/content/reference/types/type-aliases/AnyBlock.md @@ -0,0 +1,12 @@ +# Type Alias: AnyBlock + +```ts +type AnyBlock: KnownBlock | Block; +``` + +A helper union type of all known Blocks as well as the generic [Block](../interfaces/Block.md) interface. A full list of known blocks +is available here: [Blocks reference](https://api.slack.com/reference/block-kit/blocks). + +## Defined in + +[block-kit/blocks.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L58) diff --git a/docs/content/reference/types/type-aliases/CallUser.md b/docs/content/reference/types/type-aliases/CallUser.md new file mode 100644 index 000000000..724d33267 --- /dev/null +++ b/docs/content/reference/types/type-aliases/CallUser.md @@ -0,0 +1,13 @@ +# Type Alias: CallUser + +```ts +type CallUser: CallUserSlack | CallUserExternal; +``` + +## Description + +For use in representing [users in a Slack Call](https://api.slack.com/apis/calls#users). + +## Defined in + +[calls.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L8) diff --git a/docs/content/reference/types/type-aliases/ColorScheme.md b/docs/content/reference/types/type-aliases/ColorScheme.md new file mode 100644 index 000000000..a23397a0c --- /dev/null +++ b/docs/content/reference/types/type-aliases/ColorScheme.md @@ -0,0 +1,12 @@ +# Type Alias: ColorScheme + +```ts +type ColorScheme: "primary" | "danger"; +``` + +Re-usable labels for common color schemes present in Slack. `danger` displays with a red background (red text on +mobile), while `primary` displays with a green background (green text on mobile). + +## Defined in + +[block-kit/composition-objects.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L7) diff --git a/docs/content/reference/types/type-aliases/ContextBlockElement.md b/docs/content/reference/types/type-aliases/ContextBlockElement.md new file mode 100644 index 000000000..7c2f6f144 --- /dev/null +++ b/docs/content/reference/types/type-aliases/ContextBlockElement.md @@ -0,0 +1,15 @@ +# Type Alias: ContextBlockElement + +```ts +type ContextBlockElement: ImageElement | TextObject; +``` + +A helper union type of all Block Elements that can be used in a [ContextBlock](../interfaces/ContextBlock.md). + +## See + +[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). + +## Defined in + +[block-kit/blocks.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L87) diff --git a/docs/content/reference/types/type-aliases/ConversationFilter.md b/docs/content/reference/types/type-aliases/ConversationFilter.md new file mode 100644 index 000000000..30bbeea5d --- /dev/null +++ b/docs/content/reference/types/type-aliases/ConversationFilter.md @@ -0,0 +1,18 @@ +# Type Alias: ConversationFilter + +```ts +type ConversationFilter: BaseConversationFilter & Required> | BaseConversationFilter & Required> | BaseConversationFilter & Required>; +``` + +## Description + +Defines a filter for the list of options in a conversation selector menu. The menu can be either a +conversations select menu or a conversations multi-select menu. + +## See + +[Conversation filter object reference](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations). + +## Defined in + +[block-kit/composition-objects.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L199) diff --git a/docs/content/reference/types/type-aliases/ConversationType.md b/docs/content/reference/types/type-aliases/ConversationType.md new file mode 100644 index 000000000..5d09b5698 --- /dev/null +++ b/docs/content/reference/types/type-aliases/ConversationType.md @@ -0,0 +1,11 @@ +# Type Alias: ConversationType + +```ts +type ConversationType: "im" | "mpim" | "private" | "public"; +``` + +The conversation type as available within the Slack UI. + +## Defined in + +[block-kit/composition-objects.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L10) diff --git a/docs/content/reference/types/type-aliases/ImageBlock.md b/docs/content/reference/types/type-aliases/ImageBlock.md new file mode 100644 index 000000000..e45c98b4b --- /dev/null +++ b/docs/content/reference/types/type-aliases/ImageBlock.md @@ -0,0 +1,51 @@ +# Type Alias: ImageBlock + +```ts +type ImageBlock: object & Block & UrlImageObject | SlackFileImageObject; +``` + +## Type declaration + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A plain-text summary of the image. This should not contain any markup. +Maximum length for this field is 2000 characters. + +### title? + +```ts +optional title: PlainTextElement; +``` + +#### Description + +An optional title for the image in the form of a [PlainTextElement](../interfaces/PlainTextElement.md) object. +Maximum length for the text in this field is 2000 characters. + +### type + +```ts +type: "image"; +``` + +#### Description + +The type of block. For an image block, `type` is always `image`. + +## Description + +Displays an image. A simple image block, designed to make those cat photos really pop. + +## See + +[Image block reference](https://api.slack.com/reference/block-kit/blocks#image). + +## Defined in + +[block-kit/blocks.ts:160](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L160) diff --git a/docs/content/reference/types/type-aliases/ImageElement.md b/docs/content/reference/types/type-aliases/ImageElement.md new file mode 100644 index 000000000..09634fe96 --- /dev/null +++ b/docs/content/reference/types/type-aliases/ImageElement.md @@ -0,0 +1,40 @@ +# Type Alias: ImageElement + +```ts +type ImageElement: object & UrlImageObject | SlackFileImageObject; +``` + +## Type declaration + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A plain-text summary of the image. This should not contain any markup. + +### type + +```ts +type: "image"; +``` + +#### Description + +The type of element. In this case `type` is always `image`. + +## Description + +Displays an image as part of a larger block of content. Use this `image` block if you want a block with +only an image in it. + +## See + +[Image element reference](https://api.slack.com/reference/block-kit/block-elements#image). + +## Defined in + +[block-kit/block-elements.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L177) diff --git a/docs/content/reference/types/type-aliases/InputBlockElement.md b/docs/content/reference/types/type-aliases/InputBlockElement.md new file mode 100644 index 000000000..5fcf50d79 --- /dev/null +++ b/docs/content/reference/types/type-aliases/InputBlockElement.md @@ -0,0 +1,28 @@ +# Type Alias: InputBlockElement + +```ts +type InputBlockElement: + | Checkboxes + | Datepicker + | DateTimepicker + | EmailInput + | FileInput + | MultiSelect + | NumberInput + | PlainTextInput + | RadioButtons + | RichTextInput + | Select + | Timepicker + | URLInput; +``` + +A helper union type of all Block Elements that can be used in an [InputBlock](../interfaces/InputBlock.md). + +## See + +[Input block reference](https://api.slack.com/reference/block-kit/blocks#input). + +## Defined in + +[block-kit/blocks.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L181) diff --git a/docs/content/reference/types/type-aliases/KnownBlock.md b/docs/content/reference/types/type-aliases/KnownBlock.md new file mode 100644 index 000000000..3a5dcfe4c --- /dev/null +++ b/docs/content/reference/types/type-aliases/KnownBlock.md @@ -0,0 +1,22 @@ +# Type Alias: KnownBlock + +```ts +type KnownBlock: + | ImageBlock + | ContextBlock + | ActionsBlock + | DividerBlock + | SectionBlock + | InputBlock + | FileBlock + | HeaderBlock + | VideoBlock + | RichTextBlock; +``` + +A helper union type of all known Blocks, as listed out on the +[Blocks reference](https://api.slack.com/reference/block-kit/blocks). + +## Defined in + +[block-kit/blocks.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L51) diff --git a/docs/content/reference/types/type-aliases/MultiSelect.md b/docs/content/reference/types/type-aliases/MultiSelect.md new file mode 100644 index 000000000..9349dd299 --- /dev/null +++ b/docs/content/reference/types/type-aliases/MultiSelect.md @@ -0,0 +1,28 @@ +# Type Alias: MultiSelect + +```ts +type MultiSelect: + | MultiUsersSelect + | MultiStaticSelect + | MultiConversationsSelect + | MultiChannelsSelect + | MultiExternalSelect; +``` + +## Description + +Allows users to select multiple items from a list of options. +Just like regular [Select](Select.md), multi-select menus also include type-ahead functionality, where a user can type a +part or all of an option string to filter the list. +There are different types of multi-select menu that depend on different data sources for their lists of options: +[MultiStaticSelect](../interfaces/MultiStaticSelect.md), [MultiExternalSelect](../interfaces/MultiExternalSelect.md), [MultiUsersSelect](../interfaces/MultiUsersSelect.md), [MultiConversationsSelect](../interfaces/MultiConversationsSelect.md), +[MultiChannelsSelect](../interfaces/MultiChannelsSelect.md). + +## See + + - [Multi-select menu element reference](https://api.slack.com/reference/block-kit/block-elements#multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Defined in + +[block-kit/block-elements.ts:219](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L219) diff --git a/docs/content/reference/types/type-aliases/Option.md b/docs/content/reference/types/type-aliases/Option.md new file mode 100644 index 000000000..39e635be1 --- /dev/null +++ b/docs/content/reference/types/type-aliases/Option.md @@ -0,0 +1,18 @@ +# Type Alias: Option + +```ts +type Option: MrkdwnOption | PlainTextOption; +``` + +## Description + +Defines a single item in a number of item selection elements. An object that represents a single +selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu. + +## See + +[Option object reference](https://api.slack.com/reference/block-kit/composition-objects#option). + +## Defined in + +[block-kit/composition-objects.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L109) diff --git a/docs/content/reference/types/type-aliases/RichTextBlockElement.md b/docs/content/reference/types/type-aliases/RichTextBlockElement.md new file mode 100644 index 000000000..be2858fbf --- /dev/null +++ b/docs/content/reference/types/type-aliases/RichTextBlockElement.md @@ -0,0 +1,15 @@ +# Type Alias: RichTextBlockElement + +```ts +type RichTextBlockElement: RichTextSection | RichTextList | RichTextQuote | RichTextPreformatted; +``` + +A helper union type of all Block Elements that can be used in a [RichTextBlock](../interfaces/RichTextBlock.md). + +## See + +[Rich text block reference](https://api.slack.com/reference/block-kit/blocks#rich_text). + +## Defined in + +[block-kit/blocks.ts:225](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L225) diff --git a/docs/content/reference/types/type-aliases/RichTextElement.md b/docs/content/reference/types/type-aliases/RichTextElement.md new file mode 100644 index 000000000..55615e02d --- /dev/null +++ b/docs/content/reference/types/type-aliases/RichTextElement.md @@ -0,0 +1,23 @@ +# Type Alias: RichTextElement + +```ts +type RichTextElement: + | RichTextBroadcastMention + | RichTextColor + | RichTextChannelMention + | RichTextDate + | RichTextEmoji + | RichTextLink + | RichTextTeamMention + | RichTextText + | RichTextUserMention + | RichTextUsergroupMention; +``` + +## Description + +Union of rich text sub-elements for use within rich text blocks. + +## Defined in + +[block-kit/block-elements.ts:946](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L946) diff --git a/docs/content/reference/types/type-aliases/SectionBlockAccessory.md b/docs/content/reference/types/type-aliases/SectionBlockAccessory.md new file mode 100644 index 000000000..8be75659f --- /dev/null +++ b/docs/content/reference/types/type-aliases/SectionBlockAccessory.md @@ -0,0 +1,25 @@ +# Type Alias: SectionBlockAccessory + +```ts +type SectionBlockAccessory: + | Button + | Checkboxes + | Datepicker + | ImageElement + | MultiSelect + | Overflow + | RadioButtons + | Select + | Timepicker + | WorkflowButton; +``` + +A helper union type of all Block Elements that can be used as an accessory in a [SectionBlock](../interfaces/SectionBlock.md). + +## See + +[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). + +## Defined in + +[block-kit/blocks.ts:248](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L248) diff --git a/docs/content/reference/types/type-aliases/Select.md b/docs/content/reference/types/type-aliases/Select.md new file mode 100644 index 000000000..a273bb517 --- /dev/null +++ b/docs/content/reference/types/type-aliases/Select.md @@ -0,0 +1,27 @@ +# Type Alias: Select + +```ts +type Select: + | UsersSelect + | StaticSelect + | ConversationsSelect + | ChannelsSelect + | ExternalSelect; +``` + +## Description + +Allows users to choose an option from a drop down menu. +The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to +filter the list. There are different types of select menu elements that depend on different data sources for their +lists of options: [StaticSelect](../interfaces/StaticSelect.md), [ExternalSelect](../interfaces/ExternalSelect.md), [UsersSelect](../interfaces/UsersSelect.md), [ConversationsSelect](../interfaces/ConversationsSelect.md), +[ChannelsSelect](../interfaces/ChannelsSelect.md). + +## See + + - [Select menu element reference](https://api.slack.com/reference/block-kit/block-elements#select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Defined in + +[block-kit/block-elements.ts:202](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L202) diff --git a/docs/content/reference/types/type-aliases/SlackFile.md b/docs/content/reference/types/type-aliases/SlackFile.md new file mode 100644 index 000000000..a10524f10 --- /dev/null +++ b/docs/content/reference/types/type-aliases/SlackFile.md @@ -0,0 +1,20 @@ +# Type Alias: SlackFile + +```ts +type SlackFile: SlackFileViaUrl | SlackFileViaId; +``` + +## Description + +Defines an object containing Slack file information to be used in an image block or image element. +This file https://api.slack.com/types/file must be an image and you must provide either the URL or ID. In addition, +the user posting these blocks must have access to this file. If both are provided then the payload will be rejected. +Currently only `png`, `jpg`, `jpeg`, and `gif` Slack image files are supported. + +## See + +[Slack File object reference](https://api.slack.com/reference/block-kit/composition-objects#slack_file). + +## Defined in + +[block-kit/composition-objects.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L241) diff --git a/docs/content/reference/types/type-aliases/TextObject.md b/docs/content/reference/types/type-aliases/TextObject.md new file mode 100644 index 000000000..4272bcf77 --- /dev/null +++ b/docs/content/reference/types/type-aliases/TextObject.md @@ -0,0 +1,18 @@ +# Type Alias: TextObject + +```ts +type TextObject: PlainTextElement | MrkdwnElement; +``` + +## Description + +Defines an object containing some text. Can be either a [PlainTextElement](../interfaces/PlainTextElement.md) or a +[MrkdwnElement](../interfaces/MrkdwnElement.md). + +## See + +[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). + +## Defined in + +[block-kit/composition-objects.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L132) diff --git a/docs/content/reference/types/type-aliases/View.md b/docs/content/reference/types/type-aliases/View.md new file mode 100644 index 000000000..ae64f48b1 --- /dev/null +++ b/docs/content/reference/types/type-aliases/View.md @@ -0,0 +1,9 @@ +# Type Alias: View + +```ts +type View: HomeView | ModalView | WorkflowStepView; +``` + +## Defined in + +[views.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L76) diff --git a/docs/content/reference/types/typedoc-sidebar.cjs b/docs/content/reference/types/typedoc-sidebar.cjs new file mode 100644 index 000000000..b80315b65 --- /dev/null +++ b/docs/content/reference/types/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/types/interfaces/Action","label":"Action"},{"type":"doc","id":"reference/types/interfaces/Actionable","label":"Actionable"},{"type":"doc","id":"reference/types/interfaces/ActionsBlock","label":"ActionsBlock"},{"type":"doc","id":"reference/types/interfaces/Block","label":"Block"},{"type":"doc","id":"reference/types/interfaces/Button","label":"Button"},{"type":"doc","id":"reference/types/interfaces/CallUserExternal","label":"CallUserExternal"},{"type":"doc","id":"reference/types/interfaces/CallUserSlack","label":"CallUserSlack"},{"type":"doc","id":"reference/types/interfaces/ChannelsSelect","label":"ChannelsSelect"},{"type":"doc","id":"reference/types/interfaces/Checkboxes","label":"Checkboxes"},{"type":"doc","id":"reference/types/interfaces/Confirm","label":"Confirm"},{"type":"doc","id":"reference/types/interfaces/Confirmable","label":"Confirmable"},{"type":"doc","id":"reference/types/interfaces/Confirmation","label":"Confirmation"},{"type":"doc","id":"reference/types/interfaces/ConfirmationDialog","label":"ConfirmationDialog"},{"type":"doc","id":"reference/types/interfaces/ContextBlock","label":"ContextBlock"},{"type":"doc","id":"reference/types/interfaces/ConversationsSelect","label":"ConversationsSelect"},{"type":"doc","id":"reference/types/interfaces/DateTimepicker","label":"DateTimepicker"},{"type":"doc","id":"reference/types/interfaces/Datepicker","label":"Datepicker"},{"type":"doc","id":"reference/types/interfaces/Dialog","label":"Dialog"},{"type":"doc","id":"reference/types/interfaces/DispatchActionConfig","label":"DispatchActionConfig"},{"type":"doc","id":"reference/types/interfaces/Dispatchable","label":"Dispatchable"},{"type":"doc","id":"reference/types/interfaces/DividerBlock","label":"DividerBlock"},{"type":"doc","id":"reference/types/interfaces/EmailInput","label":"EmailInput"},{"type":"doc","id":"reference/types/interfaces/ExternalSelect","label":"ExternalSelect"},{"type":"doc","id":"reference/types/interfaces/FileBlock","label":"FileBlock"},{"type":"doc","id":"reference/types/interfaces/FileInput","label":"FileInput"},{"type":"doc","id":"reference/types/interfaces/Focusable","label":"Focusable"},{"type":"doc","id":"reference/types/interfaces/HeaderBlock","label":"HeaderBlock"},{"type":"doc","id":"reference/types/interfaces/HomeView","label":"HomeView"},{"type":"doc","id":"reference/types/interfaces/InputBlock","label":"InputBlock"},{"type":"doc","id":"reference/types/interfaces/LinkUnfurls","label":"LinkUnfurls"},{"type":"doc","id":"reference/types/interfaces/MaxItemsSelectable","label":"MaxItemsSelectable"},{"type":"doc","id":"reference/types/interfaces/MessageAttachment","label":"MessageAttachment"},{"type":"doc","id":"reference/types/interfaces/MessageAttachmentField","label":"MessageAttachmentField"},{"type":"doc","id":"reference/types/interfaces/MessageMetadata","label":"MessageMetadata"},{"type":"doc","id":"reference/types/interfaces/MessageMetadataEventPayloadObject","label":"MessageMetadataEventPayloadObject"},{"type":"doc","id":"reference/types/interfaces/ModalView","label":"ModalView"},{"type":"doc","id":"reference/types/interfaces/MrkdwnElement","label":"MrkdwnElement"},{"type":"doc","id":"reference/types/interfaces/MrkdwnOption","label":"MrkdwnOption"},{"type":"doc","id":"reference/types/interfaces/MultiChannelsSelect","label":"MultiChannelsSelect"},{"type":"doc","id":"reference/types/interfaces/MultiConversationsSelect","label":"MultiConversationsSelect"},{"type":"doc","id":"reference/types/interfaces/MultiExternalSelect","label":"MultiExternalSelect"},{"type":"doc","id":"reference/types/interfaces/MultiStaticSelect","label":"MultiStaticSelect"},{"type":"doc","id":"reference/types/interfaces/MultiUsersSelect","label":"MultiUsersSelect"},{"type":"doc","id":"reference/types/interfaces/NumberInput","label":"NumberInput"},{"type":"doc","id":"reference/types/interfaces/OptionGroup","label":"OptionGroup"},{"type":"doc","id":"reference/types/interfaces/Overflow","label":"Overflow"},{"type":"doc","id":"reference/types/interfaces/Placeholdable","label":"Placeholdable"},{"type":"doc","id":"reference/types/interfaces/PlainTextElement","label":"PlainTextElement"},{"type":"doc","id":"reference/types/interfaces/PlainTextInput","label":"PlainTextInput"},{"type":"doc","id":"reference/types/interfaces/PlainTextOption","label":"PlainTextOption"},{"type":"doc","id":"reference/types/interfaces/RadioButtons","label":"RadioButtons"},{"type":"doc","id":"reference/types/interfaces/RichTextBlock","label":"RichTextBlock"},{"type":"doc","id":"reference/types/interfaces/RichTextBorderable","label":"RichTextBorderable"},{"type":"doc","id":"reference/types/interfaces/RichTextBroadcastMention","label":"RichTextBroadcastMention"},{"type":"doc","id":"reference/types/interfaces/RichTextChannelMention","label":"RichTextChannelMention"},{"type":"doc","id":"reference/types/interfaces/RichTextColor","label":"RichTextColor"},{"type":"doc","id":"reference/types/interfaces/RichTextDate","label":"RichTextDate"},{"type":"doc","id":"reference/types/interfaces/RichTextEmoji","label":"RichTextEmoji"},{"type":"doc","id":"reference/types/interfaces/RichTextInput","label":"RichTextInput"},{"type":"doc","id":"reference/types/interfaces/RichTextLink","label":"RichTextLink"},{"type":"doc","id":"reference/types/interfaces/RichTextList","label":"RichTextList"},{"type":"doc","id":"reference/types/interfaces/RichTextPreformatted","label":"RichTextPreformatted"},{"type":"doc","id":"reference/types/interfaces/RichTextQuote","label":"RichTextQuote"},{"type":"doc","id":"reference/types/interfaces/RichTextSection","label":"RichTextSection"},{"type":"doc","id":"reference/types/interfaces/RichTextStyleable","label":"RichTextStyleable"},{"type":"doc","id":"reference/types/interfaces/RichTextTeamMention","label":"RichTextTeamMention"},{"type":"doc","id":"reference/types/interfaces/RichTextText","label":"RichTextText"},{"type":"doc","id":"reference/types/interfaces/RichTextUserMention","label":"RichTextUserMention"},{"type":"doc","id":"reference/types/interfaces/RichTextUsergroupMention","label":"RichTextUsergroupMention"},{"type":"doc","id":"reference/types/interfaces/SectionBlock","label":"SectionBlock"},{"type":"doc","id":"reference/types/interfaces/SelectOption","label":"SelectOption"},{"type":"doc","id":"reference/types/interfaces/SlackFileImageObject","label":"SlackFileImageObject"},{"type":"doc","id":"reference/types/interfaces/StaticSelect","label":"StaticSelect"},{"type":"doc","id":"reference/types/interfaces/Timepicker","label":"Timepicker"},{"type":"doc","id":"reference/types/interfaces/URLInput","label":"URLInput"},{"type":"doc","id":"reference/types/interfaces/URLRespondable","label":"URLRespondable"},{"type":"doc","id":"reference/types/interfaces/UrlImageObject","label":"UrlImageObject"},{"type":"doc","id":"reference/types/interfaces/UsersSelect","label":"UsersSelect"},{"type":"doc","id":"reference/types/interfaces/VideoBlock","label":"VideoBlock"},{"type":"doc","id":"reference/types/interfaces/WorkflowButton","label":"WorkflowButton"},{"type":"doc","id":"reference/types/interfaces/WorkflowStepView","label":"WorkflowStepView"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/types/type-aliases/ActionsBlockElement","label":"ActionsBlockElement"},{"type":"doc","id":"reference/types/type-aliases/AnyBlock","label":"AnyBlock"},{"type":"doc","id":"reference/types/type-aliases/CallUser","label":"CallUser"},{"type":"doc","id":"reference/types/type-aliases/ColorScheme","label":"ColorScheme"},{"type":"doc","id":"reference/types/type-aliases/ContextBlockElement","label":"ContextBlockElement"},{"type":"doc","id":"reference/types/type-aliases/ConversationFilter","label":"ConversationFilter"},{"type":"doc","id":"reference/types/type-aliases/ConversationType","label":"ConversationType"},{"type":"doc","id":"reference/types/type-aliases/ImageBlock","label":"ImageBlock"},{"type":"doc","id":"reference/types/type-aliases/ImageElement","label":"ImageElement"},{"type":"doc","id":"reference/types/type-aliases/InputBlockElement","label":"InputBlockElement"},{"type":"doc","id":"reference/types/type-aliases/KnownBlock","label":"KnownBlock"},{"type":"doc","id":"reference/types/type-aliases/MultiSelect","label":"MultiSelect"},{"type":"doc","id":"reference/types/type-aliases/Option","label":"Option"},{"type":"doc","id":"reference/types/type-aliases/RichTextBlockElement","label":"RichTextBlockElement"},{"type":"doc","id":"reference/types/type-aliases/RichTextElement","label":"RichTextElement"},{"type":"doc","id":"reference/types/type-aliases/SectionBlockAccessory","label":"SectionBlockAccessory"},{"type":"doc","id":"reference/types/type-aliases/Select","label":"Select"},{"type":"doc","id":"reference/types/type-aliases/SlackFile","label":"SlackFile"},{"type":"doc","id":"reference/types/type-aliases/TextObject","label":"TextObject"},{"type":"doc","id":"reference/types/type-aliases/View","label":"View"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/web-api/classes/Methods.md b/docs/content/reference/web-api/classes/Methods.md new file mode 100644 index 000000000..d97471ed3 --- /dev/null +++ b/docs/content/reference/web-api/classes/Methods.md @@ -0,0 +1,4593 @@ +# Class: `abstract` Methods + +A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the +`apiCall` class method. + +## Extends + +- `EventEmitter`\<[`WebClientEvent`](../enumerations/WebClientEvent.md)\> + +## Extended by + +- [`WebClient`](WebClient.md) + +## Constructors + +### new Methods() + +```ts +protected new Methods(): Methods +``` + +#### Returns + +[`Methods`](Methods.md) + +#### Overrides + +`EventEmitter.constructor` + +#### Defined in + +[packages/web-api/src/methods.ts:534](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L534) + +## Properties + +### admin + +```ts +readonly admin: object; +``` + +#### analytics + +```ts +analytics: object; +``` + +#### analytics.getFile + +```ts +getFile: Method; +``` + +##### Description + +Retrieve analytics data for a given date, presented as a compressed JSON file. + +##### See + +[`api.test` API reference](https://api.slack.com/methods/api.test). + +#### apps + +```ts +apps: object; +``` + +#### apps.activities + +```ts +activities: object; +``` + +#### apps.activities.list + +```ts +list: Method; +``` + +##### Description + +Get logs for a specified team/org. + +##### See + +[`admin.apps.activities.list` API reference](https://api.slack.com/methods/admin.apps.activities.list). + +#### apps.approve + +```ts +approve: Method; +``` + +##### Description + +Approve an app for installation on a workspace. + +##### See + +[`admin.apps.approve` API reference](https://api.slack.com/methods/admin.apps.approve). + +#### apps.approved + +```ts +approved: object; +``` + +#### apps.approved.list + +```ts +list: Method; +``` + +##### Description + +List approved apps for an org or workspace. + +##### See + +[`admin.apps.approved.list` API reference](https://api.slack.com/methods/admin.apps.approved.list). + +#### apps.clearResolution + +```ts +clearResolution: Method; +``` + +##### Description + +Clear an app resolution. + +##### See + +[`admin.apps.clearResolution` API reference](https://api.slack.com/methods/admin.apps.clearResolution). + +#### apps.config + +```ts +config: object; +``` + +#### apps.config.lookup + +```ts +lookup: Method; +``` + +##### Description + +Look up the app config for connectors by their IDs. + +##### See + +[`admin.apps.config.lookup` API reference](https://api.slack.com/methods/admin.apps.config.lookup). + +#### apps.config.set + +```ts +set: Method; +``` + +##### Description + +Set the app config for a connector. + +##### See + +[`admin.apps.config.set` API reference](https://api.slack.com/methods/admin.apps.config.set). + +#### apps.requests + +```ts +requests: object; +``` + +#### apps.requests.cancel + +```ts +cancel: Method; +``` + +##### Description + +Cancel app request for team. + +##### See + +[`admin.apps.requests.cancel` API reference](https://api.slack.com/methods/admin.apps.requests.cancel). + +#### apps.requests.list + +```ts +list: Method; +``` + +##### Description + +List app requests for a team/workspace. + +##### See + +[`admin.apps.requests.list` API reference](https://api.slack.com/methods/admin.apps.requests.list). + +#### apps.restrict + +```ts +restrict: Method; +``` + +##### Description + +Restrict an app for installation on a workspace. + +##### See + +[`admin.apps.restrict` API reference](https://api.slack.com/methods/admin.apps.restrict). + +#### apps.restricted + +```ts +restricted: object; +``` + +#### apps.restricted.list + +```ts +list: Method; +``` + +##### Description + +List restricted apps for an org or workspace. + +##### See + +[`admin.apps.restricted.list` API reference](https://api.slack.com/methods/admin.apps.restricted.list). + +#### apps.uninstall + +```ts +uninstall: Method; +``` + +##### Description + +Uninstall an app from one or many workspaces, or an entire enterprise organization. + +##### See + +[`admin.apps.uninstall` API reference](https://api.slack.com/methods/admin.apps.uninstall). + +#### auth + +```ts +auth: object; +``` + +#### auth.policy + +```ts +policy: object; +``` + +#### auth.policy.assignEntities + +```ts +assignEntities: Method; +``` + +##### Description + +Assign entities to a particular authentication policy. + +##### See + +[`admin.auth.policy.assignEntities` API reference](https://api.slack.com/methods/admin.auth.policy.assignEntities). + +#### auth.policy.getEntities + +```ts +getEntities: Method; +``` + +##### Description + +Fetch all the entities assigned to a particular authentication policy by name. + +##### See + +[`admin.auth.policy.getEntities` API reference](https://api.slack.com/methods/admin.auth.policy.getEntities). + +#### auth.policy.removeEntities + +```ts +removeEntities: Method; +``` + +##### Description + +Remove specified entities from a specified authentication policy. + +##### See + +[`admin.auth.policy.removeEntities` API reference](https://api.slack.com/methods/admin.auth.policy.removeEntities). + +#### barriers + +```ts +barriers: object; +``` + +#### barriers.create + +```ts +create: Method; +``` + +##### Description + +Create an Information Barrier. + +##### See + +[`admin.barriers.create` API reference](https://api.slack.com/methods/admin.barriers.create). + +#### barriers.delete + +```ts +delete: Method; +``` + +##### Description + +Delete an existing Information Barrier. + +##### See + +[`admin.barriers.delete` API reference](https://api.slack.com/methods/admin.barriers.delete). + +#### barriers.list + +```ts +list: Method; +``` + +##### Description + +Get all Information Barriers for your organization. + +##### See + +[`admin.barriers.list` API reference](https://api.slack.com/methods/admin.barriers.list). + +#### barriers.update + +```ts +update: Method; +``` + +##### Description + +Update an existing Information Barrier. + +##### See + +[`admin.barriers.update` API reference](https://api.slack.com/methods/admin.barriers.update). + +#### conversations + +```ts +conversations: object; +``` + +#### conversations.archive + +```ts +archive: Method; +``` + +##### Description + +Archive a public or private channel. + +##### See + +[`admin.conversations.archive` API reference](https://api.slack.com/methods/admin.conversations.archive). + +#### conversations.bulkArchive + +```ts +bulkArchive: Method; +``` + +##### Description + +Archive public or private channels in bulk. + +##### See + +[`admin.conversations.bulkArchive` API reference](https://api.slack.com/methods/admin.conversations.bulkArchive). + +#### conversations.bulkDelete + +```ts +bulkDelete: Method; +``` + +##### Description + +Delete public or private channels in bulk. + +##### See + +[`admin.conversations.bulkDelete` API reference](https://api.slack.com/methods/admin.conversations.bulkDelet). + +#### conversations.bulkMove + +```ts +bulkMove: Method; +``` + +##### Description + +Move public or private channels in bulk. + +##### See + +[`admin.conversations.bulkMove` API reference](https://api.slack.com/methods/admin.conversations.bulkMove). + +#### conversations.convertToPrivate + +```ts +convertToPrivate: Method; +``` + +##### Description + +Convert a public channel to a private channel. + +##### See + +[`admin.conversations.convertToPrivate` API reference](https://api.slack.com/methods/admin.conversations.convertToPrivate). + +#### conversations.convertToPublic + +```ts +convertToPublic: Method; +``` + +##### Description + +Convert a private channel to a public channel. + +##### See + +[`admin.conversations.convertToPublic` API reference](https://api.slack.com/methods/admin.conversations.convertToPublic). + +#### conversations.create + +```ts +create: Method; +``` + +##### Description + +Create a public or private channel-based conversation. + +##### See + +[`admin.conversations.create` API reference](https://api.slack.com/methods/admin.conversations.create). + +#### conversations.delete + +```ts +delete: Method; +``` + +##### Description + +Delete a public or private channel. + +##### See + +[`admin.conversations.delete` API reference](https://api.slack.com/methods/admin.conversations.delete). + +#### conversations.disconnectShared + +```ts +disconnectShared: Method; +``` + +##### Description + +Disconnect a connected channel from one or more workspaces. + +##### See + +[`admin.conversations.disconnectShared` API reference](https://api.slack.com/methods/admin.conversations.disconnectShared). + +#### conversations.ekm + +```ts +ekm: object; +``` + +#### conversations.ekm.listOriginalConnectedChannelInfo + +```ts +listOriginalConnectedChannelInfo: Method; +``` + +##### Description + +List all disconnected channels — i.e., channels that were once connected to other workspaces +and then disconnected — and the corresponding original channel IDs for key revocation with EKM. + +##### See + +[`admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference](https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo). + +#### conversations.getConversationPrefs + +```ts +getConversationPrefs: Method; +``` + +##### Description + +Get conversation preferences for a public or private channel. + +##### See + +[`admin.conversations.getConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.getConversationPrefs). + +#### conversations.getCustomRetention + +```ts +getCustomRetention: Method; +``` + +##### Description + +Get a conversation's retention policy. + +##### See + +[`admin.conversations.getCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.getCustomRetention). + +#### conversations.getTeams + +```ts +getTeams: Method; +``` + +##### Description + +Get all the workspaces a given public or private channel is connected to within +this Enterprise org. + +##### See + +[`admin.conversations.getTeams` API reference](https://api.slack.com/methods/admin.conversations.getTeams). + +#### conversations.invite + +```ts +invite: Method; +``` + +##### Description + +Invite a user to a public or private channel. + +##### See + +[`admin.conversations.invite` API reference](https://api.slack.com/methods/admin.conversations.invite). + +#### conversations.lookup + +```ts +lookup: Method; +``` + +##### Description + +Returns channels on the given team using the filters. + +##### See + +[`admin.conversations.lookup` API reference](https://api.slack.com/methods/admin.conversations.lookup). + +#### conversations.removeCustomRetention + +```ts +removeCustomRetention: Method; +``` + +##### Description + +Remove a conversation's retention policy. + +##### See + +[`admin.conversations.removeCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.removeCustomRetention). + +#### conversations.rename + +```ts +rename: Method; +``` + +##### Description + +Rename a public or private channel. + +##### See + +[`admin.conversations.rename` API reference](https://api.slack.com/methods/admin.conversations.rename). + +#### conversations.restrictAccess + +```ts +restrictAccess: object; +``` + +#### conversations.restrictAccess.addGroup + +```ts +addGroup: Method; +``` + +##### Description + +Add an allowlist of IDP groups for accessing a channel. + +##### See + +[`admin.conversations.restrictAccess.addGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup). + +#### conversations.restrictAccess.listGroups + +```ts +listGroups: Method; +``` + +##### Description + +List all IDP Groups linked to a channel. + +##### See + +[`admin.conversations.restrictAccess.listGroups` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups). + +#### conversations.restrictAccess.removeGroup + +```ts +removeGroup: Method; +``` + +##### Description + +Remove a linked IDP group linked from a private channel. + +##### See + +[`admin.conversations.restrictAccess.removeGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup). + +#### conversations.search + +```ts +search: Method; +``` + +##### Description + +Search for public or private channels in an Enterprise organization. + +##### See + +[`admin.conversations.search` API reference](https://api.slack.com/methods/admin.conversations.search). + +#### conversations.setConversationPrefs + +```ts +setConversationPrefs: Method; +``` + +##### Description + +Set the posting permissions for a public or private channel. + +##### See + +[`admin.conversations.setConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.setConversationPrefs). + +#### conversations.setCustomRetention + +```ts +setCustomRetention: Method; +``` + +##### Description + +Set a conversation's retention policy. + +##### See + +[`admin.conversations.setCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.setCustomRetention). + +#### conversations.setTeams + +```ts +setTeams: Method; +``` + +##### Description + +Set the workspaces in an Enterprise grid org that connect to a public or private channel. + +##### See + +[`admin.conversations.setTeams` API reference](https://api.slack.com/methods/admin.conversations.setTeams). + +#### conversations.unarchive + +```ts +unarchive: Method; +``` + +##### Description + +Unarchive a public or private channel. + +##### See + +[`admin.conversations.unarchive` API reference](https://api.slack.com/methods/admin.conversations.unarchive). + +#### emoji + +```ts +emoji: object; +``` + +#### emoji.add + +```ts +add: Method; +``` + +##### Description + +Add an emoji. + +##### See + +[`admin.emoji.add` API reference](https://api.slack.com/methods/admin.emoji.add). + +#### emoji.addAlias + +```ts +addAlias: Method; +``` + +##### Description + +Add an emoji alias. + +##### See + +[`admin.emoji.addAlias` API reference](https://api.slack.com/methods/admin.emoji.addAlias). + +#### emoji.list + +```ts +list: Method; +``` + +##### Description + +List emoji for an Enterprise Grid organization. + +##### See + +[`admin.emoji.list` API reference](https://api.slack.com/methods/admin.emoji.list). + +#### emoji.remove + +```ts +remove: Method; +``` + +##### Description + +Remove an emoji across an Enterprise Grid organization. + +##### See + +[`admin.emoji.remove` API reference](https://api.slack.com/methods/admin.emoji.remove). + +#### emoji.rename + +```ts +rename: Method; +``` + +##### Description + +Rename an emoji. + +##### See + +[`admin.emoji.rename` API reference](https://api.slack.com/methods/admin.emoji.rename). + +#### functions + +```ts +functions: object; +``` + +#### functions.list + +```ts +list: Method; +``` + +##### Description + +Look up functions by a set of apps. + +##### See + +[`admin.functions.list` API reference](https://api.slack.com/methods/admin.functions.list). + +#### functions.permissions + +```ts +permissions: object; +``` + +#### functions.permissions.lookup + +```ts +lookup: Method; +``` + +##### Description + +Lookup the visibility of multiple Slack functions and include the users if +it is limited to particular named entities. + +##### See + +[`admin.functions.permissions.lookup` API reference](https://api.slack.com/methods/admin.functions.permissions.lookup). + +#### functions.permissions.set + +```ts +set: Method; +``` + +##### Description + +Set the visibility of a Slack function and define the users or workspaces if +it is set to named_entities. + +##### See + +[`admin.functions.permissions.set` API reference](https://api.slack.com/methods/admin.functions.permissions.set). + +#### inviteRequests + +```ts +inviteRequests: object; +``` + +#### inviteRequests.approve + +```ts +approve: Method; +``` + +##### Description + +Approve a workspace invite request. + +##### See + +[`admin.inviteRequests.approve` API reference](https://api.slack.com/methods/admin.inviteRequests.approve). + +#### inviteRequests.approved + +```ts +approved: object; +``` + +#### inviteRequests.approved.list + +```ts +list: Method; +``` + +##### Description + +List all approved workspace invite requests. + +##### See + +[`admin.inviteRequests.approved.list` API reference](https://api.slack.com/methods/admin.inviteRequests.approved.list). + +#### inviteRequests.denied + +```ts +denied: object; +``` + +#### inviteRequests.denied.list + +```ts +list: Method; +``` + +##### Description + +List all denied workspace invite requests. + +##### See + +[`admin.inviteRequests.denied.list` API reference](https://api.slack.com/methods/admin.inviteRequests.denied.list). + +#### inviteRequests.deny + +```ts +deny: Method; +``` + +##### Description + +Deny a workspace invite request. + +##### See + +[`admin.inviteRequests.deny` API reference](https://api.slack.com/methods/admin.inviteRequests.deny). + +#### inviteRequests.list + +```ts +list: Method; +``` + +##### Description + +List all pending workspace invite requests. + +##### See + +[`admin.inviteRequests.list` API reference](https://api.slack.com/methods/admin.inviteRequests.list). + +#### roles + +```ts +roles: object; +``` + +#### roles.addAssignments + +```ts +addAssignments: Method; +``` + +##### Description + +Adds members to the specified role with the specified scopes. + +##### See + +[`admin.roles.addAssignments` API reference](https://api.slack.com/methods/admin.roles.addAssignments). + +#### roles.listAssignments + +```ts +listAssignments: Method; +``` + +##### Description + +Lists assignments for all roles across entities. +Options to scope results by any combination of roles or entities. + +##### See + +[`admin.roles.listAssignments` API reference](https://api.slack.com/methods/admin.roles.listAssignments). + +#### roles.removeAssignments + +```ts +removeAssignments: Method; +``` + +##### Description + +Removes a set of users from a role for the given scopes and entities. + +##### See + +[`admin.roles.removeAssignments` API reference](https://api.slack.com/methods/admin.roles.removeAssignments). + +#### teams + +```ts +teams: object; +``` + +#### teams.admins + +```ts +admins: object; +``` + +#### teams.admins.list + +```ts +list: Method; +``` + +##### Description + +List all of the admins on a given workspace. + +##### See + +[`admin.teams.admins.list` API reference](https://api.slack.com/methods/admin.teams.admins.list). + +#### teams.create + +```ts +create: Method; +``` + +##### Description + +Create an Enterprise team. + +##### See + +[`admin.teams.create` API reference](https://api.slack.com/methods/admin.teams.create). + +#### teams.list + +```ts +list: Method; +``` + +##### Description + +List all teams on an Enterprise organization. + +##### See + +[`admin.teams.list` API reference](https://api.slack.com/methods/admin.teams.list). + +#### teams.owners + +```ts +owners: object; +``` + +#### teams.owners.list + +```ts +list: Method; +``` + +##### Description + +List all of the owners on a given workspace. + +##### See + +[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). + +#### teams.settings + +```ts +settings: object; +``` + +#### teams.settings.info + +```ts +info: Method; +``` + +##### Description + +Fetch information about settings in a workspace. + +##### See + +[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). + +#### teams.settings.setDefaultChannels + +```ts +setDefaultChannels: Method; +``` + +##### Description + +Set the default channels of a workspace. + +##### See + +[`admin.teams.settings.setDefaultChannels` API reference](https://api.slack.com/methods/admin.teams.settings.setDefaultChannels). + +#### teams.settings.setDescription + +```ts +setDescription: Method; +``` + +##### Description + +Set the description of a given workspace. + +##### See + +[`admin.teams.settings.setDescription` API reference](https://api.slack.com/methods/admin.teams.settings.setDescription). + +#### teams.settings.setDiscoverability + +```ts +setDiscoverability: Method; +``` + +##### Description + +Set the discoverability of a given workspace. + +##### See + +[`admin.teams.settings.setDiscoverability` API reference](https://api.slack.com/methods/admin.teams.settings.setDiscoverability). + +#### teams.settings.setIcon + +```ts +setIcon: Method; +``` + +##### Description + +Sets the icon of a workspace. + +##### See + +[`admin.teams.settings.setIcon` API reference](https://api.slack.com/methods/admin.teams.settings.setIcon). + +#### teams.settings.setName + +```ts +setName: Method; +``` + +##### Description + +Set the name of a given workspace. + +##### See + +[`admin.teams.settings.setName` API reference](https://api.slack.com/methods/admin.teams.settings.setName). + +#### usergroups + +```ts +usergroups: object; +``` + +#### usergroups.addChannels + +```ts +addChannels: Method; +``` + +##### Description + +Add up to one hundred default channels to an IDP group. + +##### See + +[`admin.teams.usergroups.addChannels` API reference](https://api.slack.com/methods/admin.usergroups.addChannels). + +#### usergroups.addTeams + +```ts +addTeams: Method; +``` + +##### Description + +Associate one or more default workspaces with an organization-wide IDP group. + +##### See + +[`admin.teams.usergroups.addTeams` API reference](https://api.slack.com/methods/admin.usergroups.addTeams). + +#### usergroups.listChannels + +```ts +listChannels: Method; +``` + +##### Description + +List the channels linked to an org-level IDP group (user group). + +##### See + +[`admin.teams.usergroups.listChannels` API reference](https://api.slack.com/methods/admin.usergroups.listChannels). + +#### usergroups.removeChannels + +```ts +removeChannels: Method; +``` + +##### Description + +Remove one or more default channels from an org-level IDP group (user group). + +##### See + +[`admin.teams.usergroups.removeChannels` API reference](https://api.slack.com/methods/admin.usergroups.removeChannels). + +#### users + +```ts +users: object; +``` + +#### users.assign + +```ts +assign: Method; +``` + +##### Description + +Add an Enterprise user to a workspace. + +##### See + +[`admin.users.assign` API reference](https://api.slack.com/methods/admin.users.assign). + +#### users.invite + +```ts +invite: Method; +``` + +##### Description + +Invite a user to a workspace. + +##### See + +[`admin.users.invite` API reference](https://api.slack.com/methods/admin.users.invite). + +#### users.list + +```ts +list: Method; +``` + +##### Description + +List users on a workspace. + +##### See + +[`admin.users.list` API reference](https://api.slack.com/methods/admin.users.list). + +#### users.remove + +```ts +remove: Method; +``` + +##### Description + +Remove a user from a workspace. + +##### See + +[`admin.users.remove` API reference](https://api.slack.com/methods/admin.users.remove). + +#### users.session + +```ts +session: object; +``` + +#### users.session.clearSettings + +```ts +clearSettings: Method; +``` + +##### Description + +Clear user-specific session settings—the session duration and what happens when the client +closes—for a list of users. + +##### See + +[`admin.users.session.clearSettings` API reference](https://api.slack.com/methods/admin.users.session.clearSettings). + +#### users.session.getSettings + +```ts +getSettings: Method; +``` + +##### Description + +Get user-specific session settings—the session duration and what happens when the client +closes—given a list of users. + +##### See + +[`admin.users.session.getSettings` API reference](https://api.slack.com/methods/admin.users.session.getSettings). + +#### users.session.invalidate + +```ts +invalidate: Method; +``` + +##### Description + +Revoke a single session for a user. The user will be forced to login to Slack. + +##### See + +[`admin.users.session.invalidate` API reference](https://api.slack.com/methods/admin.users.session.invalidate). + +#### users.session.list + +```ts +list: Method; +``` + +##### Description + +List active user sessions for an organization. + +##### See + +[`admin.users.session.list` API reference](https://api.slack.com/methods/admin.users.session.list). + +#### users.session.reset + +```ts +reset: Method; +``` + +##### Description + +Wipes all valid sessions on all devices for a given user. + +##### See + +[`admin.users.session.reset` API reference](https://api.slack.com/methods/admin.users.session.reset). + +#### users.session.resetBulk + +```ts +resetBulk: Method; +``` + +##### Description + +Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list. + +##### See + +[`admin.users.session.resetBulk` API reference](https://api.slack.com/methods/admin.users.session.resetBulk). + +#### users.session.setSettings + +```ts +setSettings: Method; +``` + +##### Description + +Configure the user-level session settings—the session duration and what happens when the client +closes—for one or more users. + +##### See + +[`admin.users.session.setSettings` API reference](https://api.slack.com/methods/admin.users.session.setSettings). + +#### users.setAdmin + +```ts +setAdmin: Method; +``` + +##### Description + +Set an existing guest, regular user, or owner to be an admin user. + +##### See + +[`admin.users.setAdmin` API reference](https://api.slack.com/methods/admin.users.setAdmin). + +#### users.setExpiration + +```ts +setExpiration: Method; +``` + +##### Description + +Set an expiration for a guest user. + +##### See + +[`admin.users.setExpiration` API reference](https://api.slack.com/methods/admin.users.setExpiration). + +#### users.setOwner + +```ts +setOwner: Method; +``` + +##### Description + +Set an existing guest, regular user, or admin user to be a workspace owner. + +##### See + +[`admin.users.setOwner` API reference](https://api.slack.com/methods/admin.users.setOwner). + +#### users.setRegular + +```ts +setRegular: Method; +``` + +##### Description + +Set an existing guest user, admin user, or owner to be a regular user. + +##### See + +[`admin.users.setRegular` API reference](https://api.slack.com/methods/admin.users.setRegular). + +#### users.unsupportedVersions + +```ts +unsupportedVersions: object; +``` + +#### users.unsupportedVersions.export + +```ts +export: Method; +``` + +##### Description + +Ask Slackbot to send you an export listing all workspace members using unsupported software, +presented as a zipped CSV file. + +##### See + +[`admin.users.unsupportedVersions.export` API reference](https://api.slack.com/methods/admin.users.unsupportedVersions.export). + +#### workflows + +```ts +workflows: object; +``` + +#### workflows.collaborators + +```ts +collaborators: object; +``` + +#### workflows.collaborators.add + +```ts +add: Method; +``` + +##### Description + +Add collaborators to workflows within the team or enterprise. + +##### See + +[`admin.workflows.collaborators.add` API reference](https://api.slack.com/methods/admin.workflows.collaborators.add). + +#### workflows.collaborators.remove + +```ts +remove: Method; +``` + +##### Description + +Remove collaborators from workflows within the team or enterprise. + +##### See + +[`admin.workflows.collaborators.remove` API reference](https://api.slack.com/methods/admin.workflows.collaborators.remove). + +#### workflows.permissions + +```ts +permissions: object; +``` + +#### workflows.permissions.lookup + +```ts +lookup: Method; +``` + +##### Description + +Look up the permissions for a set of workflows. + +##### See + +[`admin.workflows.permissions.lookup` API reference](https://api.slack.com/methods/admin.workflows.permissions.lookup). + +#### workflows.search + +```ts +search: Method; +``` + +##### Description + +Search workflows within the team or enterprise. + +##### See + +[`admin.workflows.search` API reference](https://api.slack.com/methods/admin.workflows.search). + +#### workflows.unpublish + +```ts +unpublish: Method; +``` + +##### Description + +Unpublish workflows within the team or enterprise. + +##### See + +[`admin.workflows.unpublish` API reference](https://api.slack.com/methods/admin.workflows.unpublish). + +#### Defined in + +[packages/web-api/src/methods.ts:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L546) + +*** + +### api + +```ts +readonly api: object; +``` + +#### test + +```ts +test: Method; +``` + +##### Description + +Checks API calling code. + +##### See + +[`api.test` API reference](https://api.slack.com/methods/api.test). + +#### Defined in + +[packages/web-api/src/methods.ts:1221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1221) + +*** + +### apps + +```ts +readonly apps: object; +``` + +#### connections + +```ts +connections: object; +``` + +#### connections.open + +```ts +open: Method; +``` + +##### Description + +Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive +events and interactive payloads over. + +##### See + +[`apps.connections.open` API reference](https://api.slack.com/methods/apps.connections.open). + +#### event + +```ts +event: object; +``` + +#### event.authorizations + +```ts +authorizations: object; +``` + +#### event.authorizations.list + +```ts +list: Method; +``` + +##### Description + +Get a list of authorizations for the given event context. +Each authorization represents an app installation that the event is visible to. + +##### See + +[`apps.event.authorizations.list` API reference](https://api.slack.com/methods/apps.event.authorizations.list). + +#### manifest + +```ts +manifest: object; +``` + +#### manifest.create + +```ts +create: Method; +``` + +##### Description + +Create an app from an app manifest. + +##### See + +[`apps.manifest.create` API reference](https://api.slack.com/methods/apps.manifest.create). + +#### manifest.delete + +```ts +delete: Method; +``` + +##### Description + +Permanently deletes an app created through app manifests. + +##### See + +[`apps.manifest.delete` API reference](https://api.slack.com/methods/apps.manifest.delete). + +#### manifest.export + +```ts +export: Method; +``` + +##### Description + +Export an app manifest from an existing app. + +##### See + +[`apps.manifest.export` API reference](https://api.slack.com/methods/apps.manifest.export). + +#### manifest.update + +```ts +update: Method; +``` + +##### Description + +Update an app from an app manifest. + +##### See + +[`apps.manifest.update` API reference](https://api.slack.com/methods/apps.manifest.update). + +#### manifest.validate + +```ts +validate: Method; +``` + +##### Description + +Validate an app manifest. + +##### See + +[`apps.manifest.validate` API reference](https://api.slack.com/methods/apps.manifest.validate). + +#### uninstall + +```ts +uninstall: Method; +``` + +##### Description + +Uninstalls your app from a workspace. + +##### See + +[`apps.uninstall` API reference](https://api.slack.com/methods/apps.uninstall). + +#### Defined in + +[packages/web-api/src/methods.ts:1229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1229) + +*** + +### auth + +```ts +readonly auth: object; +``` + +#### revoke + +```ts +revoke: Method; +``` + +##### Description + +Revokes a token. + +##### See + +[`auth.revoke` API reference](https://api.slack.com/methods/auth.revoke). + +#### teams + +```ts +teams: object; +``` + +#### teams.list + +```ts +list: Method; +``` + +##### Description + +Obtain a full list of workspaces your org-wide app has been approved for. + +##### See + +[`auth.teams.list` API reference](https://api.slack.com/methods/auth.teams.list). + +#### test + +```ts +test: Method; +``` + +#### Defined in + +[packages/web-api/src/methods.ts:1285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1285) + +*** + +### bookmarks + +```ts +readonly bookmarks: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Add bookmark to a channel. + +##### See + +[`bookmarks.add` API reference](https://api.slack.com/methods/bookmarks.add). + +#### edit + +```ts +edit: Method; +``` + +##### Description + +Edit bookmark. + +##### See + +[`bookmarks.edit` API reference](https://api.slack.com/methods/bookmarks.edit). + +#### list + +```ts +list: Method; +``` + +##### Description + +List bookmarks for a channel. + +##### See + +[`bookmarks.list` API reference](https://api.slack.com/methods/bookmarks.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Remove bookmark from a channel. + +##### See + +[`bookmarks.remove` API reference](https://api.slack.com/methods/bookmarks.remove). + +#### Defined in + +[packages/web-api/src/methods.ts:1301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1301) + +*** + +### bots + +```ts +readonly bots: object; +``` + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a bot user. + +##### See + +[`bots.info` API reference](https://api.slack.com/methods/bots.info). + +#### Defined in + +[packages/web-api/src/methods.ts:1324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1324) + +*** + +### calls + +```ts +readonly calls: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Registers a new Call. + +##### See + +[`calls.add` API reference](https://api.slack.com/methods/calls.add). + +#### end + +```ts +end: Method; +``` + +##### Description + +Ends a Call. + +##### See + +[`calls.end` API reference](https://api.slack.com/methods/calls.end). + +#### info + +```ts +info: Method; +``` + +##### Description + +Returns information about a Call. + +##### See + +[`calls.info` API reference](https://api.slack.com/methods/calls.info). + +#### participants + +```ts +participants: object; +``` + +#### participants.add + +```ts +add: Method; +``` + +##### Description + +Registers new participants added to a Call. + +##### See + +[`calls.participants.add` API reference](https://api.slack.com/methods/calls.participants.add). + +#### participants.remove + +```ts +remove: Method; +``` + +#### update + +```ts +update: Method; +``` + +##### Description + +Updates information about a Call. + +##### See + +[`calls.info` API reference](https://api.slack.com/methods/calls.info). + +#### Defined in + +[packages/web-api/src/methods.ts:1332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1332) + +*** + +### canvases + +```ts +readonly canvases: object; +``` + +#### access + +```ts +access: object; +``` + +#### access.delete + +```ts +delete: Method; +``` + +##### Description + +Remove access to a canvas for specified entities. + +##### See + +[`canvases.access.delete` API reference](https://api.slack.com/methods/canvases.access.delete). + +#### access.set + +```ts +set: Method; +``` + +##### Description + +Sets the access level to a canvas for specified entities. + +##### See + +[`canvases.access.set` API reference](https://api.slack.com/methods/canvases.access.set). + +#### create + +```ts +create: Method; +``` + +##### Description + +Create Canvas for a user. + +##### See + +[`canvases.create` API reference](https://api.slack.com/methods/canvases.create). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a canvas. + +##### See + +[`canvases.delete` API reference](https://api.slack.com/methods/canvases.delete). + +#### edit + +```ts +edit: Method; +``` + +##### Description + +Update an existing canvas. + +##### See + +[`canvases.edit` API reference](https://api.slack.com/methods/canvases.edit). + +#### sections + +```ts +sections: object; +``` + +#### sections.lookup + +```ts +lookup: Method; +``` + +##### Description + +Find sections matching the provided criteria. + +##### See + +[`canvases.sections.lookup` API reference](https://api.slack.com/methods/canvases.sections.lookup). + +#### Defined in + +[packages/web-api/src/methods.ts:1363](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1363) + +*** + +### chat + +```ts +readonly chat: object; +``` + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a message. + +##### See + +[`chat.delete` API reference](https://api.slack.com/methods/chat.delete). + +#### deleteScheduledMessage + +```ts +deleteScheduledMessage: Method; +``` + +##### Description + +Deletes a pending scheduled message from the queue. + +##### See + +[`chat.deleteScheduledMessage` API reference](https://api.slack.com/methods/chat.deleteScheduledMessage). + +#### getPermalink + +```ts +getPermalink: Method; +``` + +##### Description + +Retrieve a permalink URL for a specific extant message. + +##### See + +[`chat.getPermalink` API reference](https://api.slack.com/methods/chat.getPermalink). + +#### meMessage + +```ts +meMessage: Method; +``` + +##### Description + +Share a me message into a channel. + +##### See + +[`chat.meMessage` API reference](https://api.slack.com/methods/chat.meMessage). + +#### postEphemeral + +```ts +postEphemeral: Method; +``` + +##### Description + +Sends an ephemeral message to a user in a channel. + +##### See + +[`chat.postEphemeral` API reference](https://api.slack.com/methods/chat.postEphemeral). + +#### postMessage + +```ts +postMessage: Method; +``` + +##### Description + +Sends a message to a channel. + +##### See + +[`chat.postMessage` API reference](https://api.slack.com/methods/chat.postMessage). + +#### scheduleMessage + +```ts +scheduleMessage: Method; +``` + +##### Description + +Schedules a message to be sent to a channel. + +##### See + +[`chat.scheduleMessage` API reference](https://api.slack.com/methods/chat.scheduleMessage). + +#### scheduledMessages + +```ts +scheduledMessages: object; +``` + +#### scheduledMessages.list + +```ts +list: Method; +``` + +##### Description + +Returns a list of scheduled messages. + +##### See + +[`chat.scheduledMessages.list` API reference](https://api.slack.com/methods/chat.scheduledMessages.list). + +#### unfurl + +```ts +unfurl: Method; +``` + +##### Description + +Provide custom unfurl behavior for user-posted URLs. + +##### See + +[`chat.unfurl` API reference](https://api.slack.com/methods/chat.unfurl). + +#### update + +```ts +update: Method; +``` + +##### Description + +Updates a message. + +##### See + +[`chat.update` API reference](https://api.slack.com/methods/chat.update). + +#### Defined in + +[packages/web-api/src/methods.ts:1400](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1400) + +*** + +### conversations + +```ts +readonly conversations: object; +``` + +#### acceptSharedInvite + +```ts +acceptSharedInvite: Method; +``` + +##### Description + +Accepts an invitation to a Slack Connect channel. + +##### See + +[`conversations.acceptSharedInvite` API reference](https://api.slack.com/methods/conversations.acceptSharedInvite). + +#### approveSharedInvite + +```ts +approveSharedInvite: Method; +``` + +##### Description + +Approves an invitation to a Slack Connect channel. + +##### See + +[`conversations.approveSharedInvite` API reference](https://api.slack.com/methods/conversations.approveSharedInvite). + +#### archive + +```ts +archive: Method; +``` + +##### Description + +Archives a conversation. + +##### See + +[`conversations.archive` API reference](https://api.slack.com/methods/conversations.archive). + +#### canvases + +```ts +canvases: object; +``` + +#### canvases.create + +```ts +create: Method; +``` + +##### Description + +Create a Channel Canvas for a channel. + +##### See + +[`conversations.canvases.create` API reference](https://api.slack.com/methods/conversations.canvases.create). + +#### close + +```ts +close: Method; +``` + +##### Description + +Closes a direct message or multi-person direct message. + +##### See + +[`conversations.close` API reference](https://api.slack.com/methods/conversations.close). + +#### create + +```ts +create: Method; +``` + +##### Description + +Initiates a public or private channel-based conversation. + +##### See + +[`conversations.create` API reference](https://api.slack.com/methods/conversations.create). + +#### declineSharedInvite + +```ts +declineSharedInvite: Method; +``` + +##### Description + +Declines an invitation to a Slack Connect channel. + +##### See + +[`conversations.declineSharedInvite` API reference](https://api.slack.com/methods/conversations.declineSharedInvite). + +#### externalInvitePermissions + +```ts +externalInvitePermissions: object; +``` + +#### externalInvitePermissions.set + +```ts +set: Method; +``` + +##### Description + +Convert a team in a shared channel from an External Limited channel to a fully shared Slack +Connect channel or vice versa. + +##### See + +[`conversations.externalInvitePermissions.set` API reference](https://api.slack.com/methods/conversations.externalInvitePermissions.set). + +#### history + +```ts +history: Method; +``` + +##### Description + +Fetches a conversation's history of messages and events. + +##### See + +[`conversations.history` API reference](https://api.slack.com/methods/conversations.history). + +#### info + +```ts +info: Method; +``` + +##### Description + +Retrieve information about a conversation. + +##### See + +[`conversations.info` API reference](https://api.slack.com/methods/conversations.info). + +#### invite + +```ts +invite: Method; +``` + +##### Description + +Invites users to a channel. + +##### See + +[`conversations.invite` API reference](https://api.slack.com/methods/conversations.invite). + +#### inviteShared + +```ts +inviteShared: Method; +``` + +##### Description + +Sends an invitation to a Slack Connect channel. + +##### See + +[`conversations.inviteShared` API reference](https://api.slack.com/methods/conversations.inviteShared). + +#### join + +```ts +join: Method; +``` + +##### Description + +Joins an existing conversation. + +##### See + +[`conversations.join` API reference](https://api.slack.com/methods/conversations.join). + +#### kick + +```ts +kick: Method; +``` + +##### Description + +Removes a user from a conversation. + +##### See + +[`conversations.kick` API reference](https://api.slack.com/methods/conversations.kick). + +#### leave + +```ts +leave: Method; +``` + +##### Description + +Leaves a conversation. + +##### See + +[`conversations.leave` API reference](https://api.slack.com/methods/conversations.leave). + +#### list + +```ts +list: Method; +``` + +##### Description + +List all channels in a Slack team. + +##### See + +[`conversations.list` API reference](https://api.slack.com/methods/conversations.list). + +#### listConnectInvites + +```ts +listConnectInvites: Method; +``` + +##### Description + +Lists shared channel invites that have been generated or received but have not been approved by +all parties. + +##### See + +[`conversations.listConnectInvites` API reference](https://api.slack.com/methods/conversations.listConnectInvites). + +#### mark + +```ts +mark: Method; +``` + +##### Description + +Sets the read cursor in a channel. + +##### See + +[`conversations.mark` API reference](https://api.slack.com/methods/conversations.mark). + +#### members + +```ts +members: Method; +``` + +##### Description + +Retrieve members of a conversation. + +##### See + +[`conversations.members` API reference](https://api.slack.com/methods/conversations.members). + +#### open + +```ts +open: Method; +``` + +##### Description + +Opens or resumes a direct message or multi-person direct message. + +##### See + +[`conversations.open` API reference](https://api.slack.com/methods/conversations.open). + +#### rename + +```ts +rename: Method; +``` + +##### Description + +Renames a conversation. + +##### See + +[`conversations.rename` API reference](https://api.slack.com/methods/conversations.rename). + +#### replies + +```ts +replies: Method; +``` + +##### Description + +Retrieve a thread of messages posted to a conversation. + +##### See + +[`conversations.replies` API reference](https://api.slack.com/methods/conversations.replies). + +#### setPurpose + +```ts +setPurpose: Method; +``` + +##### Description + +Sets the purpose for a conversation. + +##### See + +[`conversations.setPurpose` API reference](https://api.slack.com/methods/conversations.setPurpose). + +#### setTopic + +```ts +setTopic: Method; +``` + +##### Description + +Sets the topic for a conversation. + +##### See + +[`conversations.setTopic` API reference](https://api.slack.com/methods/conversations.setTopic). + +#### unarchive + +```ts +unarchive: Method; +``` + +##### Description + +Reverses conversation archival. + +##### See + +[`conversations.unarchive` API reference](https://api.slack.com/methods/conversations.unarchive). + +#### Defined in + +[packages/web-api/src/methods.ts:1463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1463) + +*** + +### dialog + +```ts +readonly dialog: object; +``` + +#### open + +```ts +open: Method; +``` + +##### Description + +Open a dialog with a user. + +##### See + +[`dialog.open` API reference](https://api.slack.com/methods/dialog.open). + +#### Defined in + +[packages/web-api/src/methods.ts:1622](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1622) + +*** + +### dnd + +```ts +readonly dnd: object; +``` + +#### endDnd + +```ts +endDnd: Method; +``` + +##### Description + +Ends the current user's Do Not Disturb session immediately. + +##### See + +[`dnd.endDnd` API reference](https://api.slack.com/methods/dnd.endDnd). + +#### endSnooze + +```ts +endSnooze: Method; +``` + +##### Description + +Ends the current user's snooze mode immediately. + +##### See + +[`dnd.endSnooze` API reference](https://api.slack.com/methods/dnd.endSnooze). + +#### info + +```ts +info: Method; +``` + +##### Description + +Retrieves a user's current Do Not Disturb status. + +##### See + +[`dnd.info` API reference](https://api.slack.com/methods/dnd.info). + +#### setSnooze + +```ts +setSnooze: Method; +``` + +##### Description + +Turns on Do Not Disturb mode for the current user, or changes its duration. + +##### See + +[`dnd.setSnooze` API reference](https://api.slack.com/methods/dnd.setSnooze). + +#### teamInfo + +```ts +teamInfo: Method; +``` + +##### Description + +Retrieves the Do Not Disturb status for up to 50 users on a team. + +##### See + +[`dnd.teamInfo` API reference](https://api.slack.com/methods/dnd.teamInfo). + +#### Defined in + +[packages/web-api/src/methods.ts:1630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1630) + +*** + +### emoji + +```ts +readonly emoji: object; +``` + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists custom emoji for a team. + +##### See + +[`emoji.list` API reference](https://api.slack.com/methods/emoji.list). + +#### Defined in + +[packages/web-api/src/methods.ts:1658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1658) + +*** + +### files + +```ts +readonly files: object; +``` + +#### comments + +```ts +comments: object; +``` + +#### comments.delete + +```ts +delete: Method; +``` + +##### Description + +Deletes an existing comment on a file. + +##### See + +[`files.comments.delete` API reference](https://api.slack.com/methods/files.comments.delete). + +#### completeUploadExternal + +```ts +completeUploadExternal: Method; +``` + +##### Description + +Finishes an upload started with [`files.getUploadURLExternal`](https://api.slack.com/methods/files.getUploadURLExternal). + +##### See + +[`files.completeUploadExternal` API reference](https://api.slack.com/methods/files.completeUploadExternal). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a file. + +##### See + +[`files.delete` API reference](https://api.slack.com/methods/files.delete). + +#### getUploadURLExternal + +```ts +getUploadURLExternal: Method; +``` + +##### Description + +Gets a URL for an edge external file upload. + +##### See + +[`files.getUploadURLExternal` API reference](https://api.slack.com/methods/files.getUploadURLExternal). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a file. + +##### See + +[`files.info` API reference](https://api.slack.com/methods/files.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +List files for a team, in a channel, or from a user with applied filters. + +##### See + +[`files.list` API reference](https://api.slack.com/methods/files.list). + +#### remote + +```ts +remote: object; +``` + +#### remote.add + +```ts +add: Method; +``` + +##### Description + +Adds a file from a remote service. + +##### See + +[`files.remote.add` API reference](https://api.slack.com/methods/files.remote.add). + +#### remote.info + +```ts +info: Method; +``` + +##### Description + +Retrieve information about a remote file added to Slack. + +##### See + +[`files.remote.info` API reference](https://api.slack.com/methods/files.remote.info). + +#### remote.list + +```ts +list: Method; +``` + +##### Description + +List remote files added to Slack. + +##### See + +[`files.remote.list` API reference](https://api.slack.com/methods/files.remote.list). + +#### remote.remove + +```ts +remove: Method; +``` + +##### Description + +Remove a remote file. + +##### See + +[`files.remote.remove` API reference](https://api.slack.com/methods/files.remote.remove). + +#### remote.share + +```ts +share: Method; +``` + +##### Description + +Share a remote file into a channel. + +##### See + +[`files.remote.share` API reference](https://api.slack.com/methods/files.remote.share). + +#### remote.update + +```ts +update: Method; +``` + +##### Description + +Updates an existing remote file. + +##### See + +[`files.remote.update` API reference](https://api.slack.com/methods/files.remote.update). + +#### revokePublicURL + +```ts +revokePublicURL: Method; +``` + +##### Description + +Revokes public/external sharing access for a file. + +##### See + +[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). + +#### sharedPublicURL + +```ts +sharedPublicURL: Method; +``` + +##### Description + +Enables a file for public/external sharing. + +##### See + +[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). + +#### ~~upload~~ + +```ts +upload: Method; +``` + +##### Description + +Uploads or creates a file. + +##### Deprecated + +Use `uploadV2` instead. See [our post on retiring `files.upload`](https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay). + +##### See + +[`files.upload` API reference](https://api.slack.com/methods/files.upload). + +#### uploadV2 + +```ts +uploadV2: Method; +``` + +##### Description + +Custom method to support a new way of uploading files to Slack. +Supports a single file upload +Supply: +- (required) single file or content +- (optional) channel, alt_text, snippet_type, +Supports multiple file uploads +Supply: +- multiple upload_files +Will try to honor both single file or content data supplied as well +as multiple file uploads property. + +##### See + +[`@slack/web-api` Upload a file documentation](https://slack.dev/node-slack-sdk/web-api#upload-a-file). + +#### Defined in + +[packages/web-api/src/methods.ts:1666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1666) + +*** + +### functions + +```ts +readonly functions: object; +``` + +#### completeError + +```ts +completeError: Method; +``` + +##### Description + +Signal the failure to execute a Custom Function. + +##### See + +[`functions.completeError` API reference](https://api.slack.com/methods/functions.completeError). + +#### completeSuccess + +```ts +completeSuccess: Method; +``` + +##### Description + +Signal the successful completion of a Custom Function. + +##### See + +[`functions.completeSuccess` API reference](https://api.slack.com/methods/functions.completeSuccess). + +#### Defined in + +[packages/web-api/src/methods.ts:1767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1767) + +*** + +### migration + +```ts +readonly migration: object; +``` + +#### exchange + +```ts +exchange: Method; +``` + +##### Description + +For Enterprise Grid workspaces, map local user IDs to global user IDs. + +##### See + +[`migration.exchange` API reference](https://api.slack.com/methods/migration.exchange). + +#### Defined in + +[packages/web-api/src/methods.ts:1783](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1783) + +*** + +### oauth + +```ts +readonly oauth: object; +``` + +#### ~~access~~ + +```ts +access: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token. + +##### Deprecated + +This is a legacy method only used by classic Slack apps. Use `oauth.v2.access` for new Slack apps. + +##### See + +[`oauth.access` API reference](https://api.slack.com/methods/oauth.access). + +#### v2 + +```ts +v2: object; +``` + +#### v2.access + +```ts +access: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token. + +##### See + +[`oauth.v2.access` API reference](https://api.slack.com/methods/oauth.v2.access). + +#### v2.exchange + +```ts +exchange: Method; +``` + +##### Description + +Exchanges a legacy access token for a new expiring access token and refresh token. + +##### See + +[`oauth.v2.exchange` API reference](https://api.slack.com/methods/oauth.v2.exchange). + +#### Defined in + +[packages/web-api/src/methods.ts:1791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1791) + +*** + +### openid + +```ts +readonly openid: object; +``` + +#### connect + +```ts +connect: object; +``` + +#### connect.token + +```ts +token: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token for [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). + +##### See + +[`openid.connect.token` API reference](https://api.slack.com/methods/openid.connect.token). + +#### connect.userInfo + +```ts +userInfo: Method; +``` + +##### Description + +Get the identity of a user who has authorized [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). + +##### See + +[`openid.connect.userInfo` API reference](https://api.slack.com/methods/openid.connect.userInfo). + +#### Defined in + +[packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) + +*** + +### pins + +```ts +readonly pins: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Pins an item to a channel. + +##### See + +[`pins.add` API reference](https://api.slack.com/methods/pins.add). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists items pinned to a channel. + +##### See + +[`pins.list` API reference](https://api.slack.com/methods/pins.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Un-pins an item from a channel. + +##### See + +[`pins.remove` API reference](https://api.slack.com/methods/pins.remove). + +#### Defined in + +[packages/web-api/src/methods.ts:1827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1827) + +*** + +### reactions + +```ts +readonly reactions: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Adds a reaction to an item. + +##### See + +[`reactions.add` API reference](https://api.slack.com/methods/reactions.add). + +#### get + +```ts +get: Method; +``` + +##### Description + +Gets reactions for an item. + +##### See + +[`reactions.get` API reference](https://api.slack.com/methods/reactions.get). + +#### list + +```ts +list: Method; +``` + +##### Description + +List reactions made by a user. + +##### See + +[`reactions.list` API reference](https://api.slack.com/methods/reactions.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Removes a reaction from an item. + +##### See + +[`reactions.remove` API reference](https://api.slack.com/methods/reactions.remove). + +#### Defined in + +[packages/web-api/src/methods.ts:1845](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1845) + +*** + +### reminders + +```ts +readonly reminders: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Creates a reminder. + +##### See + +[`reminders.add` API reference](https://api.slack.com/methods/reminders.add). + +#### complete + +```ts +complete: Method; +``` + +##### Description + +Marks a reminder as complete. + +##### See + +[`reminders.complete` API reference](https://api.slack.com/methods/reminders.complete). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a reminder. + +##### See + +[`reminders.delete` API reference](https://api.slack.com/methods/reminders.delete). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a reminder. + +##### See + +[`reminders.info` API reference](https://api.slack.com/methods/reminders.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists all reminders created by or for a given user. + +##### See + +[`reminders.list` API reference](https://api.slack.com/methods/reminders.list). + +#### Defined in + +[packages/web-api/src/methods.ts:1870](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1870) + +*** + +### rtm + +```ts +readonly rtm: object; +``` + +#### connect + +```ts +connect: Method; +``` + +##### Description + +Starts a Real Time Messaging session. + +##### See + +[`rtm.connect` API reference](https://api.slack.com/methods/rtm.connect). + +#### ~~start~~ + +```ts +start: Method; +``` + +##### Description + +Starts a Real Time Messaging session. + +##### Deprecated + +Use `rtm.connect` instead. See [our post on retiring `rtm.start`](https://api.slack.com/changelog/2021-10-rtm-start-to-stop). + +##### See + +[`rtm.start` API reference](https://api.slack.com/methods/rtm.start). + +#### Defined in + +[packages/web-api/src/methods.ts:1898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1898) + +*** + +### search + +```ts +readonly search: object; +``` + +#### all + +```ts +all: Method; +``` + +##### Description + +Searches for messages and files matching a query. + +##### See + +[search.all` API reference](https://api.slack.com/methods/search.all). + +#### files + +```ts +files: Method; +``` + +##### Description + +Searches for files matching a query. + +##### See + +[search.files` API reference](https://api.slack.com/methods/search.files). + +#### messages + +```ts +messages: Method; +``` + +##### Description + +Searches for messages matching a query. + +##### See + +[search.messages` API reference](https://api.slack.com/methods/search.messages). + +#### Defined in + +[packages/web-api/src/methods.ts:1912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1912) + +*** + +### stars + +```ts +readonly stars: object; +``` + +#### ~~add~~ + +```ts +add: Method; +``` + +##### Description + +Save an item for later. Formerly known as adding a star. + +##### Deprecated + +Stars can still be added but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.add` API reference](https://api.slack.com/methods/stars.add). + +#### ~~list~~ + +```ts +list: Method; +``` + +##### Description + +List a user's saved items, formerly known as stars. + +##### Deprecated + +Stars can still be listed but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.list` API reference](https://api.slack.com/methods/stars.list). + +#### ~~remove~~ + +```ts +remove: Method; +``` + +##### Description + +Remove a saved item from a user's saved items, formerly known as stars. + +##### Deprecated + +Stars can still be removed but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.remove` API reference](https://api.slack.com/methods/stars.remove). + +#### Defined in + +[packages/web-api/src/methods.ts:2140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2140) + +*** + +### team + +```ts +readonly team: object; +``` + +#### accessLogs + +```ts +accessLogs: Method; +``` + +##### Description + +Gets the access logs for the current team. + +##### See + +[`team.accessLogs` API reference](https://api.slack.com/methods/team.accessLogs). + +#### billableInfo + +```ts +billableInfo: Method; +``` + +##### Description + +Gets billable users information for the current team. + +##### See + +[`team.billableInfo` API reference](https://api.slack.com/methods/team.billableInfo). + +#### billing + +```ts +billing: object; +``` + +#### billing.info + +```ts +info: Method; +``` + +##### Description + +Reads a workspace's billing plan information. + +##### See + +[`team.billing.info` API reference](https://api.slack.com/methods/team.billing.info). + +#### externalTeams + +```ts +externalTeams: object; +``` + +#### externalTeams.disconnect + +```ts +disconnect: Method; +``` + +##### Description + +Disconnect an external organization. + +##### See + +[`team.externalTeams.disconnect` API reference](https://api.slack.com/methods/team.externalTeams.disconnect). + +#### externalTeams.list + +```ts +list: Method; +``` + +##### Description + +Returns a list of all the external teams connected and details about the connection. + +##### See + +[`team.externalTeams.list` API reference](https://api.slack.com/methods/team.externalTeams.list). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about the current team. + +##### See + +[`team.info` API reference](https://api.slack.com/methods/team.info). + +#### integrationLogs + +```ts +integrationLogs: Method; +``` + +##### Description + +Gets the integration logs for the current team. + +##### See + +[`team.integrationLogs` API reference](https://api.slack.com/methods/team.integrationLogs). + +#### preferences + +```ts +preferences: object; +``` + +#### preferences.list + +```ts +list: Method; +``` + +##### Description + +Retrieve a list of a workspace's team preferences. + +##### See + +[`team.preferences.list` API reference](https://api.slack.com/methods/team.preferences.list). + +#### profile + +```ts +profile: object; +``` + +#### profile.get + +```ts +get: Method; +``` + +##### Description + +Retrieve a team's profile. + +##### See + +[`team.profile.get` API reference](https://api.slack.com/methods/team.profile.get). + +#### Defined in + +[packages/web-api/src/methods.ts:1930](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1930) + +*** + +### tooling + +```ts +readonly tooling: object; +``` + +#### tokens + +```ts +tokens: object; +``` + +#### tokens.rotate + +```ts +rotate: Method; +``` + +##### Description + +Exchanges a refresh token for a new app configuration token. + +##### See + +[`tooling.tokens.rotate` API reference](https://api.slack.com/methods/tooling.tokens.rotate). + +#### Defined in + +[packages/web-api/src/methods.ts:1987](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1987) + +*** + +### usergroups + +```ts +readonly usergroups: object; +``` + +#### create + +```ts +create: Method; +``` + +##### Description + +Create a User Group. + +##### See + +[`usergroups.create` API reference](https://api.slack.com/methods/usergroups.create). + +#### disable + +```ts +disable: Method; +``` + +##### Description + +Disable an existing User Group. + +##### See + +[`usergroups.disable` API reference](https://api.slack.com/methods/usergroups.disable). + +#### enable + +```ts +enable: Method; +``` + +##### Description + +Enable an existing User Group. + +##### See + +[`usergroups.enable` API reference](https://api.slack.com/methods/usergroups.enable). + +#### list + +```ts +list: Method; +``` + +##### Description + +List all User Groups for a team. + +##### See + +[`usergroups.list` API reference](https://api.slack.com/methods/usergroups.list). + +#### update + +```ts +update: Method; +``` + +##### Description + +Update an existing User Group. + +##### See + +[`usergroups.update` API reference](https://api.slack.com/methods/usergroups.update). + +#### users + +```ts +users: object; +``` + +#### users.list + +```ts +list: Method; +``` + +##### Description + +List all users in a User Group. + +##### See + +[`usergroups.users.list` API reference](https://api.slack.com/methods/usergroups.users.list). + +#### users.update + +```ts +update: Method; +``` + +##### Description + +Update the list of users in a User Group. + +##### See + +[`usergroups.users.update` API reference](https://api.slack.com/methods/usergroups.users.update). + +#### Defined in + +[packages/web-api/src/methods.ts:1997](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1997) + +*** + +### users + +```ts +readonly users: object; +``` + +#### conversations + +```ts +conversations: Method; +``` + +##### Description + +List conversations the calling user may access. + +##### See + +[`users.conversations` API reference](https://api.slack.com/methods/users.conversations). + +#### deletePhoto + +```ts +deletePhoto: Method; +``` + +##### Description + +Delete the user profile photo. + +##### See + +[`users.deletePhoto` API reference](https://api.slack.com/methods/users.deletePhoto). + +#### discoverableContacts + +```ts +discoverableContacts: object; +``` + +#### discoverableContacts.lookup + +```ts +lookup: Method; +``` + +##### Description + +Lookup an email address to see if someone is on Slack. + +##### See + +[`users.discoverableContacts.lookup` API reference](https://api.slack.com/methods/users.discoverableContacts.lookup). + +#### getPresence + +```ts +getPresence: Method; +``` + +##### Description + +Gets user presence information. + +##### See + +[`users.getPresence` API reference](https://api.slack.com/methods/users.getPresence). + +#### identity + +```ts +identity: Method; +``` + +##### Description + +Get a user's identity. + +##### See + +[`users.identity` API reference](https://api.slack.com/methods/users.identity). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a user. + +##### See + +[`users.info` API reference](https://api.slack.com/methods/users.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists all users in a Slack team. + +##### See + +[`users.list` API reference](https://api.slack.com/methods/users.list). + +#### lookupByEmail + +```ts +lookupByEmail: Method; +``` + +##### Description + +Find a user with an email address. + +##### See + +[`users.lookupByEmail` API reference](https://api.slack.com/methods/users.lookupByEmail). + +#### profile + +```ts +profile: object; +``` + +#### profile.get + +```ts +get: Method; +``` + +##### Description + +Retrieve a user's profile information, including their custom status. + +##### See + +[`users.profile.get` API reference](https://api.slack.com/methods/users.profile.get). + +#### profile.set + +```ts +set: Method; +``` + +##### Description + +Set a user's profile information, including custom status. + +##### See + +[`users.profile.set` API reference](https://api.slack.com/methods/users.profile.set). + +#### setPhoto + +```ts +setPhoto: Method; +``` + +##### Description + +Set the user profile photo. + +##### See + +[`users.setPhoto` API reference](https://api.slack.com/methods/users.setPhoto). + +#### setPresence + +```ts +setPresence: Method; +``` + +##### Description + +Manually sets user presence. + +##### See + +[`users.setPresence` API reference](https://api.slack.com/methods/users.setPresence). + +#### Defined in + +[packages/web-api/src/methods.ts:2043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2043) + +*** + +### views + +```ts +readonly views: object; +``` + +#### open + +```ts +open: Method; +``` + +##### Description + +Open a view for a user. + +##### See + +[`views.open` API reference](https://api.slack.com/methods/views.open). + +#### publish + +```ts +publish: Method; +``` + +##### Description + +Publish a static view for a user. + +##### See + +[`views.publish` API reference](https://api.slack.com/methods/views.publish). + +#### push + +```ts +push: Method; +``` + +##### Description + +Push a view onto the stack of a root view. + +##### See + +[`views.push` API reference](https://api.slack.com/methods/views.push). + +#### update + +```ts +update: Method; +``` + +##### Description + +Update an existing view. + +##### See + +[`views.update` API reference](https://api.slack.com/methods/views.update). + +#### Defined in + +[packages/web-api/src/methods.ts:2110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2110) + +*** + +### workflows + +```ts +readonly workflows: object; +``` + +#### ~~stepCompleted~~ + +```ts +stepCompleted: Method; +``` + +##### Description + +Indicate that an app's step in a workflow completed execution. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.stepCompleted` API reference](https://api.slack.com/methods/workflows.stepCompleted). + +#### ~~stepFailed~~ + +```ts +stepFailed: Method; +``` + +##### Description + +Indicate that an app's step in a workflow failed to execute. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.stepFailed` API reference](https://api.slack.com/methods/workflows.stepFailed). + +#### ~~updateStep~~ + +```ts +updateStep: Method; +``` + +##### Description + +Update the configuration for a workflow step. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.updateStep` API reference](https://api.slack.com/methods/workflows.updateStep). + +#### Defined in + +[packages/web-api/src/methods.ts:2164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2164) + +*** + +### prefixed + +```ts +static prefixed: string | boolean; +``` + +#### Inherited from + +`EventEmitter.prefixed` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:9 + +## Methods + +### addListener() + +```ts +addListener( + event, + fn, + context?): this +``` + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.addListener` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:45 + +*** + +### apiCall() + +```ts +abstract apiCall(method, options?): Promise +``` + +#### Parameters + +• **method**: `string` + +• **options?**: `Record`\<`string`, `unknown`\> + +#### Returns + +`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> + +#### Defined in + +[packages/web-api/src/methods.ts:543](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L543) + +*** + +### emit() + +```ts +emit(event, ...args): boolean +``` + +Calls each of the listeners registered for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• ...**args**: `any`[] + +#### Returns + +`boolean` + +#### Inherited from + +`EventEmitter.emit` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:32 + +*** + +### eventNames() + +```ts +eventNames(): RATE_LIMITED[] +``` + +Return an array listing the events for which the emitter has registered +listeners. + +#### Returns + +[`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited)[] + +#### Inherited from + +`EventEmitter.eventNames` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:15 + +*** + +### filesUploadV2() + +```ts +abstract filesUploadV2(options): Promise +``` + +#### Parameters + +• **options**: [`FilesUploadV2Arguments`](../type-aliases/FilesUploadV2Arguments.md) + +#### Returns + +`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> + +#### Defined in + +[packages/web-api/src/methods.ts:544](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L544) + +*** + +### listenerCount() + +```ts +listenerCount(event): number +``` + +Return the number of listeners listening to a given event. + +#### Parameters + +• **event**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Returns + +`number` + +#### Inherited from + +`EventEmitter.listenerCount` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:27 + +*** + +### listeners() + +```ts +listeners(event): (...args) => void[] +``` + +Return the listeners registered for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +#### Returns + +(...`args`) => `void`[] + +#### Inherited from + +`EventEmitter.listeners` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:20 + +*** + +### off() + +```ts +off( + event, + fn?, + context?, + once?): this +``` + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn?** + +• **context?**: `any` + +• **once?**: `boolean` + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.off` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:69 + +*** + +### on() + +```ts +on( + event, + fn, + context?): this +``` + +Add a listener for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.on` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:40 + +*** + +### once() + +```ts +once( + event, + fn, + context?): this +``` + +Add a one-time listener for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.once` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:54 + +*** + +### removeAllListeners() + +```ts +removeAllListeners(event?): this +``` + +Remove all listeners, or those of the specified event. + +#### Parameters + +• **event?**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.removeAllListeners` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:79 + +*** + +### removeListener() + +```ts +removeListener( + event, + fn?, + context?, + once?): this +``` + +Remove the listeners of a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn?** + +• **context?**: `any` + +• **once?**: `boolean` + +#### Returns + +`this` + +#### Inherited from + +`EventEmitter.removeListener` + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/content/reference/web-api/classes/WebClient.md b/docs/content/reference/web-api/classes/WebClient.md new file mode 100644 index 000000000..d46aa416c --- /dev/null +++ b/docs/content/reference/web-api/classes/WebClient.md @@ -0,0 +1,4873 @@ +# Class: WebClient + +A client for Slack's Web API + +This client provides an alias for each [API method](https://api.slack.com/methods|Web). Each method is +a convenience wrapper for calling the [WebClient#apiCall](WebClient.md#apicall) method using the method name as the first parameter. + +## Extends + +- [`Methods`](Methods.md) + +## Constructors + +### new WebClient() + +```ts +new WebClient(token?, __namedParameters?): WebClient +``` + +#### Parameters + +• **token?**: `string` + +An API token to authenticate/authorize with Slack (usually start with `xoxp`, `xoxb`) + +• **\_\_namedParameters?**: [`WebClientOptions`](../interfaces/WebClientOptions.md) = `{}` + +#### Returns + +[`WebClient`](WebClient.md) + +#### Overrides + +[`Methods`](Methods.md).[`constructor`](Methods.md#constructors) + +#### Defined in + +[packages/web-api/src/WebClient.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L187) + +## Properties + +### admin + +```ts +readonly admin: object; +``` + +#### analytics + +```ts +analytics: object; +``` + +#### analytics.getFile + +```ts +getFile: Method; +``` + +##### Description + +Retrieve analytics data for a given date, presented as a compressed JSON file. + +##### See + +[`api.test` API reference](https://api.slack.com/methods/api.test). + +#### apps + +```ts +apps: object; +``` + +#### apps.activities + +```ts +activities: object; +``` + +#### apps.activities.list + +```ts +list: Method; +``` + +##### Description + +Get logs for a specified team/org. + +##### See + +[`admin.apps.activities.list` API reference](https://api.slack.com/methods/admin.apps.activities.list). + +#### apps.approve + +```ts +approve: Method; +``` + +##### Description + +Approve an app for installation on a workspace. + +##### See + +[`admin.apps.approve` API reference](https://api.slack.com/methods/admin.apps.approve). + +#### apps.approved + +```ts +approved: object; +``` + +#### apps.approved.list + +```ts +list: Method; +``` + +##### Description + +List approved apps for an org or workspace. + +##### See + +[`admin.apps.approved.list` API reference](https://api.slack.com/methods/admin.apps.approved.list). + +#### apps.clearResolution + +```ts +clearResolution: Method; +``` + +##### Description + +Clear an app resolution. + +##### See + +[`admin.apps.clearResolution` API reference](https://api.slack.com/methods/admin.apps.clearResolution). + +#### apps.config + +```ts +config: object; +``` + +#### apps.config.lookup + +```ts +lookup: Method; +``` + +##### Description + +Look up the app config for connectors by their IDs. + +##### See + +[`admin.apps.config.lookup` API reference](https://api.slack.com/methods/admin.apps.config.lookup). + +#### apps.config.set + +```ts +set: Method; +``` + +##### Description + +Set the app config for a connector. + +##### See + +[`admin.apps.config.set` API reference](https://api.slack.com/methods/admin.apps.config.set). + +#### apps.requests + +```ts +requests: object; +``` + +#### apps.requests.cancel + +```ts +cancel: Method; +``` + +##### Description + +Cancel app request for team. + +##### See + +[`admin.apps.requests.cancel` API reference](https://api.slack.com/methods/admin.apps.requests.cancel). + +#### apps.requests.list + +```ts +list: Method; +``` + +##### Description + +List app requests for a team/workspace. + +##### See + +[`admin.apps.requests.list` API reference](https://api.slack.com/methods/admin.apps.requests.list). + +#### apps.restrict + +```ts +restrict: Method; +``` + +##### Description + +Restrict an app for installation on a workspace. + +##### See + +[`admin.apps.restrict` API reference](https://api.slack.com/methods/admin.apps.restrict). + +#### apps.restricted + +```ts +restricted: object; +``` + +#### apps.restricted.list + +```ts +list: Method; +``` + +##### Description + +List restricted apps for an org or workspace. + +##### See + +[`admin.apps.restricted.list` API reference](https://api.slack.com/methods/admin.apps.restricted.list). + +#### apps.uninstall + +```ts +uninstall: Method; +``` + +##### Description + +Uninstall an app from one or many workspaces, or an entire enterprise organization. + +##### See + +[`admin.apps.uninstall` API reference](https://api.slack.com/methods/admin.apps.uninstall). + +#### auth + +```ts +auth: object; +``` + +#### auth.policy + +```ts +policy: object; +``` + +#### auth.policy.assignEntities + +```ts +assignEntities: Method; +``` + +##### Description + +Assign entities to a particular authentication policy. + +##### See + +[`admin.auth.policy.assignEntities` API reference](https://api.slack.com/methods/admin.auth.policy.assignEntities). + +#### auth.policy.getEntities + +```ts +getEntities: Method; +``` + +##### Description + +Fetch all the entities assigned to a particular authentication policy by name. + +##### See + +[`admin.auth.policy.getEntities` API reference](https://api.slack.com/methods/admin.auth.policy.getEntities). + +#### auth.policy.removeEntities + +```ts +removeEntities: Method; +``` + +##### Description + +Remove specified entities from a specified authentication policy. + +##### See + +[`admin.auth.policy.removeEntities` API reference](https://api.slack.com/methods/admin.auth.policy.removeEntities). + +#### barriers + +```ts +barriers: object; +``` + +#### barriers.create + +```ts +create: Method; +``` + +##### Description + +Create an Information Barrier. + +##### See + +[`admin.barriers.create` API reference](https://api.slack.com/methods/admin.barriers.create). + +#### barriers.delete + +```ts +delete: Method; +``` + +##### Description + +Delete an existing Information Barrier. + +##### See + +[`admin.barriers.delete` API reference](https://api.slack.com/methods/admin.barriers.delete). + +#### barriers.list + +```ts +list: Method; +``` + +##### Description + +Get all Information Barriers for your organization. + +##### See + +[`admin.barriers.list` API reference](https://api.slack.com/methods/admin.barriers.list). + +#### barriers.update + +```ts +update: Method; +``` + +##### Description + +Update an existing Information Barrier. + +##### See + +[`admin.barriers.update` API reference](https://api.slack.com/methods/admin.barriers.update). + +#### conversations + +```ts +conversations: object; +``` + +#### conversations.archive + +```ts +archive: Method; +``` + +##### Description + +Archive a public or private channel. + +##### See + +[`admin.conversations.archive` API reference](https://api.slack.com/methods/admin.conversations.archive). + +#### conversations.bulkArchive + +```ts +bulkArchive: Method; +``` + +##### Description + +Archive public or private channels in bulk. + +##### See + +[`admin.conversations.bulkArchive` API reference](https://api.slack.com/methods/admin.conversations.bulkArchive). + +#### conversations.bulkDelete + +```ts +bulkDelete: Method; +``` + +##### Description + +Delete public or private channels in bulk. + +##### See + +[`admin.conversations.bulkDelete` API reference](https://api.slack.com/methods/admin.conversations.bulkDelet). + +#### conversations.bulkMove + +```ts +bulkMove: Method; +``` + +##### Description + +Move public or private channels in bulk. + +##### See + +[`admin.conversations.bulkMove` API reference](https://api.slack.com/methods/admin.conversations.bulkMove). + +#### conversations.convertToPrivate + +```ts +convertToPrivate: Method; +``` + +##### Description + +Convert a public channel to a private channel. + +##### See + +[`admin.conversations.convertToPrivate` API reference](https://api.slack.com/methods/admin.conversations.convertToPrivate). + +#### conversations.convertToPublic + +```ts +convertToPublic: Method; +``` + +##### Description + +Convert a private channel to a public channel. + +##### See + +[`admin.conversations.convertToPublic` API reference](https://api.slack.com/methods/admin.conversations.convertToPublic). + +#### conversations.create + +```ts +create: Method; +``` + +##### Description + +Create a public or private channel-based conversation. + +##### See + +[`admin.conversations.create` API reference](https://api.slack.com/methods/admin.conversations.create). + +#### conversations.delete + +```ts +delete: Method; +``` + +##### Description + +Delete a public or private channel. + +##### See + +[`admin.conversations.delete` API reference](https://api.slack.com/methods/admin.conversations.delete). + +#### conversations.disconnectShared + +```ts +disconnectShared: Method; +``` + +##### Description + +Disconnect a connected channel from one or more workspaces. + +##### See + +[`admin.conversations.disconnectShared` API reference](https://api.slack.com/methods/admin.conversations.disconnectShared). + +#### conversations.ekm + +```ts +ekm: object; +``` + +#### conversations.ekm.listOriginalConnectedChannelInfo + +```ts +listOriginalConnectedChannelInfo: Method; +``` + +##### Description + +List all disconnected channels — i.e., channels that were once connected to other workspaces +and then disconnected — and the corresponding original channel IDs for key revocation with EKM. + +##### See + +[`admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference](https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo). + +#### conversations.getConversationPrefs + +```ts +getConversationPrefs: Method; +``` + +##### Description + +Get conversation preferences for a public or private channel. + +##### See + +[`admin.conversations.getConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.getConversationPrefs). + +#### conversations.getCustomRetention + +```ts +getCustomRetention: Method; +``` + +##### Description + +Get a conversation's retention policy. + +##### See + +[`admin.conversations.getCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.getCustomRetention). + +#### conversations.getTeams + +```ts +getTeams: Method; +``` + +##### Description + +Get all the workspaces a given public or private channel is connected to within +this Enterprise org. + +##### See + +[`admin.conversations.getTeams` API reference](https://api.slack.com/methods/admin.conversations.getTeams). + +#### conversations.invite + +```ts +invite: Method; +``` + +##### Description + +Invite a user to a public or private channel. + +##### See + +[`admin.conversations.invite` API reference](https://api.slack.com/methods/admin.conversations.invite). + +#### conversations.lookup + +```ts +lookup: Method; +``` + +##### Description + +Returns channels on the given team using the filters. + +##### See + +[`admin.conversations.lookup` API reference](https://api.slack.com/methods/admin.conversations.lookup). + +#### conversations.removeCustomRetention + +```ts +removeCustomRetention: Method; +``` + +##### Description + +Remove a conversation's retention policy. + +##### See + +[`admin.conversations.removeCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.removeCustomRetention). + +#### conversations.rename + +```ts +rename: Method; +``` + +##### Description + +Rename a public or private channel. + +##### See + +[`admin.conversations.rename` API reference](https://api.slack.com/methods/admin.conversations.rename). + +#### conversations.restrictAccess + +```ts +restrictAccess: object; +``` + +#### conversations.restrictAccess.addGroup + +```ts +addGroup: Method; +``` + +##### Description + +Add an allowlist of IDP groups for accessing a channel. + +##### See + +[`admin.conversations.restrictAccess.addGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup). + +#### conversations.restrictAccess.listGroups + +```ts +listGroups: Method; +``` + +##### Description + +List all IDP Groups linked to a channel. + +##### See + +[`admin.conversations.restrictAccess.listGroups` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups). + +#### conversations.restrictAccess.removeGroup + +```ts +removeGroup: Method; +``` + +##### Description + +Remove a linked IDP group linked from a private channel. + +##### See + +[`admin.conversations.restrictAccess.removeGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup). + +#### conversations.search + +```ts +search: Method; +``` + +##### Description + +Search for public or private channels in an Enterprise organization. + +##### See + +[`admin.conversations.search` API reference](https://api.slack.com/methods/admin.conversations.search). + +#### conversations.setConversationPrefs + +```ts +setConversationPrefs: Method; +``` + +##### Description + +Set the posting permissions for a public or private channel. + +##### See + +[`admin.conversations.setConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.setConversationPrefs). + +#### conversations.setCustomRetention + +```ts +setCustomRetention: Method; +``` + +##### Description + +Set a conversation's retention policy. + +##### See + +[`admin.conversations.setCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.setCustomRetention). + +#### conversations.setTeams + +```ts +setTeams: Method; +``` + +##### Description + +Set the workspaces in an Enterprise grid org that connect to a public or private channel. + +##### See + +[`admin.conversations.setTeams` API reference](https://api.slack.com/methods/admin.conversations.setTeams). + +#### conversations.unarchive + +```ts +unarchive: Method; +``` + +##### Description + +Unarchive a public or private channel. + +##### See + +[`admin.conversations.unarchive` API reference](https://api.slack.com/methods/admin.conversations.unarchive). + +#### emoji + +```ts +emoji: object; +``` + +#### emoji.add + +```ts +add: Method; +``` + +##### Description + +Add an emoji. + +##### See + +[`admin.emoji.add` API reference](https://api.slack.com/methods/admin.emoji.add). + +#### emoji.addAlias + +```ts +addAlias: Method; +``` + +##### Description + +Add an emoji alias. + +##### See + +[`admin.emoji.addAlias` API reference](https://api.slack.com/methods/admin.emoji.addAlias). + +#### emoji.list + +```ts +list: Method; +``` + +##### Description + +List emoji for an Enterprise Grid organization. + +##### See + +[`admin.emoji.list` API reference](https://api.slack.com/methods/admin.emoji.list). + +#### emoji.remove + +```ts +remove: Method; +``` + +##### Description + +Remove an emoji across an Enterprise Grid organization. + +##### See + +[`admin.emoji.remove` API reference](https://api.slack.com/methods/admin.emoji.remove). + +#### emoji.rename + +```ts +rename: Method; +``` + +##### Description + +Rename an emoji. + +##### See + +[`admin.emoji.rename` API reference](https://api.slack.com/methods/admin.emoji.rename). + +#### functions + +```ts +functions: object; +``` + +#### functions.list + +```ts +list: Method; +``` + +##### Description + +Look up functions by a set of apps. + +##### See + +[`admin.functions.list` API reference](https://api.slack.com/methods/admin.functions.list). + +#### functions.permissions + +```ts +permissions: object; +``` + +#### functions.permissions.lookup + +```ts +lookup: Method; +``` + +##### Description + +Lookup the visibility of multiple Slack functions and include the users if +it is limited to particular named entities. + +##### See + +[`admin.functions.permissions.lookup` API reference](https://api.slack.com/methods/admin.functions.permissions.lookup). + +#### functions.permissions.set + +```ts +set: Method; +``` + +##### Description + +Set the visibility of a Slack function and define the users or workspaces if +it is set to named_entities. + +##### See + +[`admin.functions.permissions.set` API reference](https://api.slack.com/methods/admin.functions.permissions.set). + +#### inviteRequests + +```ts +inviteRequests: object; +``` + +#### inviteRequests.approve + +```ts +approve: Method; +``` + +##### Description + +Approve a workspace invite request. + +##### See + +[`admin.inviteRequests.approve` API reference](https://api.slack.com/methods/admin.inviteRequests.approve). + +#### inviteRequests.approved + +```ts +approved: object; +``` + +#### inviteRequests.approved.list + +```ts +list: Method; +``` + +##### Description + +List all approved workspace invite requests. + +##### See + +[`admin.inviteRequests.approved.list` API reference](https://api.slack.com/methods/admin.inviteRequests.approved.list). + +#### inviteRequests.denied + +```ts +denied: object; +``` + +#### inviteRequests.denied.list + +```ts +list: Method; +``` + +##### Description + +List all denied workspace invite requests. + +##### See + +[`admin.inviteRequests.denied.list` API reference](https://api.slack.com/methods/admin.inviteRequests.denied.list). + +#### inviteRequests.deny + +```ts +deny: Method; +``` + +##### Description + +Deny a workspace invite request. + +##### See + +[`admin.inviteRequests.deny` API reference](https://api.slack.com/methods/admin.inviteRequests.deny). + +#### inviteRequests.list + +```ts +list: Method; +``` + +##### Description + +List all pending workspace invite requests. + +##### See + +[`admin.inviteRequests.list` API reference](https://api.slack.com/methods/admin.inviteRequests.list). + +#### roles + +```ts +roles: object; +``` + +#### roles.addAssignments + +```ts +addAssignments: Method; +``` + +##### Description + +Adds members to the specified role with the specified scopes. + +##### See + +[`admin.roles.addAssignments` API reference](https://api.slack.com/methods/admin.roles.addAssignments). + +#### roles.listAssignments + +```ts +listAssignments: Method; +``` + +##### Description + +Lists assignments for all roles across entities. +Options to scope results by any combination of roles or entities. + +##### See + +[`admin.roles.listAssignments` API reference](https://api.slack.com/methods/admin.roles.listAssignments). + +#### roles.removeAssignments + +```ts +removeAssignments: Method; +``` + +##### Description + +Removes a set of users from a role for the given scopes and entities. + +##### See + +[`admin.roles.removeAssignments` API reference](https://api.slack.com/methods/admin.roles.removeAssignments). + +#### teams + +```ts +teams: object; +``` + +#### teams.admins + +```ts +admins: object; +``` + +#### teams.admins.list + +```ts +list: Method; +``` + +##### Description + +List all of the admins on a given workspace. + +##### See + +[`admin.teams.admins.list` API reference](https://api.slack.com/methods/admin.teams.admins.list). + +#### teams.create + +```ts +create: Method; +``` + +##### Description + +Create an Enterprise team. + +##### See + +[`admin.teams.create` API reference](https://api.slack.com/methods/admin.teams.create). + +#### teams.list + +```ts +list: Method; +``` + +##### Description + +List all teams on an Enterprise organization. + +##### See + +[`admin.teams.list` API reference](https://api.slack.com/methods/admin.teams.list). + +#### teams.owners + +```ts +owners: object; +``` + +#### teams.owners.list + +```ts +list: Method; +``` + +##### Description + +List all of the owners on a given workspace. + +##### See + +[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). + +#### teams.settings + +```ts +settings: object; +``` + +#### teams.settings.info + +```ts +info: Method; +``` + +##### Description + +Fetch information about settings in a workspace. + +##### See + +[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). + +#### teams.settings.setDefaultChannels + +```ts +setDefaultChannels: Method; +``` + +##### Description + +Set the default channels of a workspace. + +##### See + +[`admin.teams.settings.setDefaultChannels` API reference](https://api.slack.com/methods/admin.teams.settings.setDefaultChannels). + +#### teams.settings.setDescription + +```ts +setDescription: Method; +``` + +##### Description + +Set the description of a given workspace. + +##### See + +[`admin.teams.settings.setDescription` API reference](https://api.slack.com/methods/admin.teams.settings.setDescription). + +#### teams.settings.setDiscoverability + +```ts +setDiscoverability: Method; +``` + +##### Description + +Set the discoverability of a given workspace. + +##### See + +[`admin.teams.settings.setDiscoverability` API reference](https://api.slack.com/methods/admin.teams.settings.setDiscoverability). + +#### teams.settings.setIcon + +```ts +setIcon: Method; +``` + +##### Description + +Sets the icon of a workspace. + +##### See + +[`admin.teams.settings.setIcon` API reference](https://api.slack.com/methods/admin.teams.settings.setIcon). + +#### teams.settings.setName + +```ts +setName: Method; +``` + +##### Description + +Set the name of a given workspace. + +##### See + +[`admin.teams.settings.setName` API reference](https://api.slack.com/methods/admin.teams.settings.setName). + +#### usergroups + +```ts +usergroups: object; +``` + +#### usergroups.addChannels + +```ts +addChannels: Method; +``` + +##### Description + +Add up to one hundred default channels to an IDP group. + +##### See + +[`admin.teams.usergroups.addChannels` API reference](https://api.slack.com/methods/admin.usergroups.addChannels). + +#### usergroups.addTeams + +```ts +addTeams: Method; +``` + +##### Description + +Associate one or more default workspaces with an organization-wide IDP group. + +##### See + +[`admin.teams.usergroups.addTeams` API reference](https://api.slack.com/methods/admin.usergroups.addTeams). + +#### usergroups.listChannels + +```ts +listChannels: Method; +``` + +##### Description + +List the channels linked to an org-level IDP group (user group). + +##### See + +[`admin.teams.usergroups.listChannels` API reference](https://api.slack.com/methods/admin.usergroups.listChannels). + +#### usergroups.removeChannels + +```ts +removeChannels: Method; +``` + +##### Description + +Remove one or more default channels from an org-level IDP group (user group). + +##### See + +[`admin.teams.usergroups.removeChannels` API reference](https://api.slack.com/methods/admin.usergroups.removeChannels). + +#### users + +```ts +users: object; +``` + +#### users.assign + +```ts +assign: Method; +``` + +##### Description + +Add an Enterprise user to a workspace. + +##### See + +[`admin.users.assign` API reference](https://api.slack.com/methods/admin.users.assign). + +#### users.invite + +```ts +invite: Method; +``` + +##### Description + +Invite a user to a workspace. + +##### See + +[`admin.users.invite` API reference](https://api.slack.com/methods/admin.users.invite). + +#### users.list + +```ts +list: Method; +``` + +##### Description + +List users on a workspace. + +##### See + +[`admin.users.list` API reference](https://api.slack.com/methods/admin.users.list). + +#### users.remove + +```ts +remove: Method; +``` + +##### Description + +Remove a user from a workspace. + +##### See + +[`admin.users.remove` API reference](https://api.slack.com/methods/admin.users.remove). + +#### users.session + +```ts +session: object; +``` + +#### users.session.clearSettings + +```ts +clearSettings: Method; +``` + +##### Description + +Clear user-specific session settings—the session duration and what happens when the client +closes—for a list of users. + +##### See + +[`admin.users.session.clearSettings` API reference](https://api.slack.com/methods/admin.users.session.clearSettings). + +#### users.session.getSettings + +```ts +getSettings: Method; +``` + +##### Description + +Get user-specific session settings—the session duration and what happens when the client +closes—given a list of users. + +##### See + +[`admin.users.session.getSettings` API reference](https://api.slack.com/methods/admin.users.session.getSettings). + +#### users.session.invalidate + +```ts +invalidate: Method; +``` + +##### Description + +Revoke a single session for a user. The user will be forced to login to Slack. + +##### See + +[`admin.users.session.invalidate` API reference](https://api.slack.com/methods/admin.users.session.invalidate). + +#### users.session.list + +```ts +list: Method; +``` + +##### Description + +List active user sessions for an organization. + +##### See + +[`admin.users.session.list` API reference](https://api.slack.com/methods/admin.users.session.list). + +#### users.session.reset + +```ts +reset: Method; +``` + +##### Description + +Wipes all valid sessions on all devices for a given user. + +##### See + +[`admin.users.session.reset` API reference](https://api.slack.com/methods/admin.users.session.reset). + +#### users.session.resetBulk + +```ts +resetBulk: Method; +``` + +##### Description + +Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list. + +##### See + +[`admin.users.session.resetBulk` API reference](https://api.slack.com/methods/admin.users.session.resetBulk). + +#### users.session.setSettings + +```ts +setSettings: Method; +``` + +##### Description + +Configure the user-level session settings—the session duration and what happens when the client +closes—for one or more users. + +##### See + +[`admin.users.session.setSettings` API reference](https://api.slack.com/methods/admin.users.session.setSettings). + +#### users.setAdmin + +```ts +setAdmin: Method; +``` + +##### Description + +Set an existing guest, regular user, or owner to be an admin user. + +##### See + +[`admin.users.setAdmin` API reference](https://api.slack.com/methods/admin.users.setAdmin). + +#### users.setExpiration + +```ts +setExpiration: Method; +``` + +##### Description + +Set an expiration for a guest user. + +##### See + +[`admin.users.setExpiration` API reference](https://api.slack.com/methods/admin.users.setExpiration). + +#### users.setOwner + +```ts +setOwner: Method; +``` + +##### Description + +Set an existing guest, regular user, or admin user to be a workspace owner. + +##### See + +[`admin.users.setOwner` API reference](https://api.slack.com/methods/admin.users.setOwner). + +#### users.setRegular + +```ts +setRegular: Method; +``` + +##### Description + +Set an existing guest user, admin user, or owner to be a regular user. + +##### See + +[`admin.users.setRegular` API reference](https://api.slack.com/methods/admin.users.setRegular). + +#### users.unsupportedVersions + +```ts +unsupportedVersions: object; +``` + +#### users.unsupportedVersions.export + +```ts +export: Method; +``` + +##### Description + +Ask Slackbot to send you an export listing all workspace members using unsupported software, +presented as a zipped CSV file. + +##### See + +[`admin.users.unsupportedVersions.export` API reference](https://api.slack.com/methods/admin.users.unsupportedVersions.export). + +#### workflows + +```ts +workflows: object; +``` + +#### workflows.collaborators + +```ts +collaborators: object; +``` + +#### workflows.collaborators.add + +```ts +add: Method; +``` + +##### Description + +Add collaborators to workflows within the team or enterprise. + +##### See + +[`admin.workflows.collaborators.add` API reference](https://api.slack.com/methods/admin.workflows.collaborators.add). + +#### workflows.collaborators.remove + +```ts +remove: Method; +``` + +##### Description + +Remove collaborators from workflows within the team or enterprise. + +##### See + +[`admin.workflows.collaborators.remove` API reference](https://api.slack.com/methods/admin.workflows.collaborators.remove). + +#### workflows.permissions + +```ts +permissions: object; +``` + +#### workflows.permissions.lookup + +```ts +lookup: Method; +``` + +##### Description + +Look up the permissions for a set of workflows. + +##### See + +[`admin.workflows.permissions.lookup` API reference](https://api.slack.com/methods/admin.workflows.permissions.lookup). + +#### workflows.search + +```ts +search: Method; +``` + +##### Description + +Search workflows within the team or enterprise. + +##### See + +[`admin.workflows.search` API reference](https://api.slack.com/methods/admin.workflows.search). + +#### workflows.unpublish + +```ts +unpublish: Method; +``` + +##### Description + +Unpublish workflows within the team or enterprise. + +##### See + +[`admin.workflows.unpublish` API reference](https://api.slack.com/methods/admin.workflows.unpublish). + +#### Inherited from + +[`Methods`](Methods.md).[`admin`](Methods.md#admin) + +#### Defined in + +[packages/web-api/src/methods.ts:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L546) + +*** + +### api + +```ts +readonly api: object; +``` + +#### test + +```ts +test: Method; +``` + +##### Description + +Checks API calling code. + +##### See + +[`api.test` API reference](https://api.slack.com/methods/api.test). + +#### Inherited from + +[`Methods`](Methods.md).[`api`](Methods.md#api) + +#### Defined in + +[packages/web-api/src/methods.ts:1221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1221) + +*** + +### apps + +```ts +readonly apps: object; +``` + +#### connections + +```ts +connections: object; +``` + +#### connections.open + +```ts +open: Method; +``` + +##### Description + +Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive +events and interactive payloads over. + +##### See + +[`apps.connections.open` API reference](https://api.slack.com/methods/apps.connections.open). + +#### event + +```ts +event: object; +``` + +#### event.authorizations + +```ts +authorizations: object; +``` + +#### event.authorizations.list + +```ts +list: Method; +``` + +##### Description + +Get a list of authorizations for the given event context. +Each authorization represents an app installation that the event is visible to. + +##### See + +[`apps.event.authorizations.list` API reference](https://api.slack.com/methods/apps.event.authorizations.list). + +#### manifest + +```ts +manifest: object; +``` + +#### manifest.create + +```ts +create: Method; +``` + +##### Description + +Create an app from an app manifest. + +##### See + +[`apps.manifest.create` API reference](https://api.slack.com/methods/apps.manifest.create). + +#### manifest.delete + +```ts +delete: Method; +``` + +##### Description + +Permanently deletes an app created through app manifests. + +##### See + +[`apps.manifest.delete` API reference](https://api.slack.com/methods/apps.manifest.delete). + +#### manifest.export + +```ts +export: Method; +``` + +##### Description + +Export an app manifest from an existing app. + +##### See + +[`apps.manifest.export` API reference](https://api.slack.com/methods/apps.manifest.export). + +#### manifest.update + +```ts +update: Method; +``` + +##### Description + +Update an app from an app manifest. + +##### See + +[`apps.manifest.update` API reference](https://api.slack.com/methods/apps.manifest.update). + +#### manifest.validate + +```ts +validate: Method; +``` + +##### Description + +Validate an app manifest. + +##### See + +[`apps.manifest.validate` API reference](https://api.slack.com/methods/apps.manifest.validate). + +#### uninstall + +```ts +uninstall: Method; +``` + +##### Description + +Uninstalls your app from a workspace. + +##### See + +[`apps.uninstall` API reference](https://api.slack.com/methods/apps.uninstall). + +#### Inherited from + +[`Methods`](Methods.md).[`apps`](Methods.md#apps-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1229) + +*** + +### auth + +```ts +readonly auth: object; +``` + +#### revoke + +```ts +revoke: Method; +``` + +##### Description + +Revokes a token. + +##### See + +[`auth.revoke` API reference](https://api.slack.com/methods/auth.revoke). + +#### teams + +```ts +teams: object; +``` + +#### teams.list + +```ts +list: Method; +``` + +##### Description + +Obtain a full list of workspaces your org-wide app has been approved for. + +##### See + +[`auth.teams.list` API reference](https://api.slack.com/methods/auth.teams.list). + +#### test + +```ts +test: Method; +``` + +#### Inherited from + +[`Methods`](Methods.md).[`auth`](Methods.md#auth-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1285) + +*** + +### bookmarks + +```ts +readonly bookmarks: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Add bookmark to a channel. + +##### See + +[`bookmarks.add` API reference](https://api.slack.com/methods/bookmarks.add). + +#### edit + +```ts +edit: Method; +``` + +##### Description + +Edit bookmark. + +##### See + +[`bookmarks.edit` API reference](https://api.slack.com/methods/bookmarks.edit). + +#### list + +```ts +list: Method; +``` + +##### Description + +List bookmarks for a channel. + +##### See + +[`bookmarks.list` API reference](https://api.slack.com/methods/bookmarks.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Remove bookmark from a channel. + +##### See + +[`bookmarks.remove` API reference](https://api.slack.com/methods/bookmarks.remove). + +#### Inherited from + +[`Methods`](Methods.md).[`bookmarks`](Methods.md#bookmarks) + +#### Defined in + +[packages/web-api/src/methods.ts:1301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1301) + +*** + +### bots + +```ts +readonly bots: object; +``` + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a bot user. + +##### See + +[`bots.info` API reference](https://api.slack.com/methods/bots.info). + +#### Inherited from + +[`Methods`](Methods.md).[`bots`](Methods.md#bots) + +#### Defined in + +[packages/web-api/src/methods.ts:1324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1324) + +*** + +### calls + +```ts +readonly calls: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Registers a new Call. + +##### See + +[`calls.add` API reference](https://api.slack.com/methods/calls.add). + +#### end + +```ts +end: Method; +``` + +##### Description + +Ends a Call. + +##### See + +[`calls.end` API reference](https://api.slack.com/methods/calls.end). + +#### info + +```ts +info: Method; +``` + +##### Description + +Returns information about a Call. + +##### See + +[`calls.info` API reference](https://api.slack.com/methods/calls.info). + +#### participants + +```ts +participants: object; +``` + +#### participants.add + +```ts +add: Method; +``` + +##### Description + +Registers new participants added to a Call. + +##### See + +[`calls.participants.add` API reference](https://api.slack.com/methods/calls.participants.add). + +#### participants.remove + +```ts +remove: Method; +``` + +#### update + +```ts +update: Method; +``` + +##### Description + +Updates information about a Call. + +##### See + +[`calls.info` API reference](https://api.slack.com/methods/calls.info). + +#### Inherited from + +[`Methods`](Methods.md).[`calls`](Methods.md#calls) + +#### Defined in + +[packages/web-api/src/methods.ts:1332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1332) + +*** + +### canvases + +```ts +readonly canvases: object; +``` + +#### access + +```ts +access: object; +``` + +#### access.delete + +```ts +delete: Method; +``` + +##### Description + +Remove access to a canvas for specified entities. + +##### See + +[`canvases.access.delete` API reference](https://api.slack.com/methods/canvases.access.delete). + +#### access.set + +```ts +set: Method; +``` + +##### Description + +Sets the access level to a canvas for specified entities. + +##### See + +[`canvases.access.set` API reference](https://api.slack.com/methods/canvases.access.set). + +#### create + +```ts +create: Method; +``` + +##### Description + +Create Canvas for a user. + +##### See + +[`canvases.create` API reference](https://api.slack.com/methods/canvases.create). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a canvas. + +##### See + +[`canvases.delete` API reference](https://api.slack.com/methods/canvases.delete). + +#### edit + +```ts +edit: Method; +``` + +##### Description + +Update an existing canvas. + +##### See + +[`canvases.edit` API reference](https://api.slack.com/methods/canvases.edit). + +#### sections + +```ts +sections: object; +``` + +#### sections.lookup + +```ts +lookup: Method; +``` + +##### Description + +Find sections matching the provided criteria. + +##### See + +[`canvases.sections.lookup` API reference](https://api.slack.com/methods/canvases.sections.lookup). + +#### Inherited from + +[`Methods`](Methods.md).[`canvases`](Methods.md#canvases) + +#### Defined in + +[packages/web-api/src/methods.ts:1363](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1363) + +*** + +### chat + +```ts +readonly chat: object; +``` + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a message. + +##### See + +[`chat.delete` API reference](https://api.slack.com/methods/chat.delete). + +#### deleteScheduledMessage + +```ts +deleteScheduledMessage: Method; +``` + +##### Description + +Deletes a pending scheduled message from the queue. + +##### See + +[`chat.deleteScheduledMessage` API reference](https://api.slack.com/methods/chat.deleteScheduledMessage). + +#### getPermalink + +```ts +getPermalink: Method; +``` + +##### Description + +Retrieve a permalink URL for a specific extant message. + +##### See + +[`chat.getPermalink` API reference](https://api.slack.com/methods/chat.getPermalink). + +#### meMessage + +```ts +meMessage: Method; +``` + +##### Description + +Share a me message into a channel. + +##### See + +[`chat.meMessage` API reference](https://api.slack.com/methods/chat.meMessage). + +#### postEphemeral + +```ts +postEphemeral: Method; +``` + +##### Description + +Sends an ephemeral message to a user in a channel. + +##### See + +[`chat.postEphemeral` API reference](https://api.slack.com/methods/chat.postEphemeral). + +#### postMessage + +```ts +postMessage: Method; +``` + +##### Description + +Sends a message to a channel. + +##### See + +[`chat.postMessage` API reference](https://api.slack.com/methods/chat.postMessage). + +#### scheduleMessage + +```ts +scheduleMessage: Method; +``` + +##### Description + +Schedules a message to be sent to a channel. + +##### See + +[`chat.scheduleMessage` API reference](https://api.slack.com/methods/chat.scheduleMessage). + +#### scheduledMessages + +```ts +scheduledMessages: object; +``` + +#### scheduledMessages.list + +```ts +list: Method; +``` + +##### Description + +Returns a list of scheduled messages. + +##### See + +[`chat.scheduledMessages.list` API reference](https://api.slack.com/methods/chat.scheduledMessages.list). + +#### unfurl + +```ts +unfurl: Method; +``` + +##### Description + +Provide custom unfurl behavior for user-posted URLs. + +##### See + +[`chat.unfurl` API reference](https://api.slack.com/methods/chat.unfurl). + +#### update + +```ts +update: Method; +``` + +##### Description + +Updates a message. + +##### See + +[`chat.update` API reference](https://api.slack.com/methods/chat.update). + +#### Inherited from + +[`Methods`](Methods.md).[`chat`](Methods.md#chat) + +#### Defined in + +[packages/web-api/src/methods.ts:1400](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1400) + +*** + +### conversations + +```ts +readonly conversations: object; +``` + +#### acceptSharedInvite + +```ts +acceptSharedInvite: Method; +``` + +##### Description + +Accepts an invitation to a Slack Connect channel. + +##### See + +[`conversations.acceptSharedInvite` API reference](https://api.slack.com/methods/conversations.acceptSharedInvite). + +#### approveSharedInvite + +```ts +approveSharedInvite: Method; +``` + +##### Description + +Approves an invitation to a Slack Connect channel. + +##### See + +[`conversations.approveSharedInvite` API reference](https://api.slack.com/methods/conversations.approveSharedInvite). + +#### archive + +```ts +archive: Method; +``` + +##### Description + +Archives a conversation. + +##### See + +[`conversations.archive` API reference](https://api.slack.com/methods/conversations.archive). + +#### canvases + +```ts +canvases: object; +``` + +#### canvases.create + +```ts +create: Method; +``` + +##### Description + +Create a Channel Canvas for a channel. + +##### See + +[`conversations.canvases.create` API reference](https://api.slack.com/methods/conversations.canvases.create). + +#### close + +```ts +close: Method; +``` + +##### Description + +Closes a direct message or multi-person direct message. + +##### See + +[`conversations.close` API reference](https://api.slack.com/methods/conversations.close). + +#### create + +```ts +create: Method; +``` + +##### Description + +Initiates a public or private channel-based conversation. + +##### See + +[`conversations.create` API reference](https://api.slack.com/methods/conversations.create). + +#### declineSharedInvite + +```ts +declineSharedInvite: Method; +``` + +##### Description + +Declines an invitation to a Slack Connect channel. + +##### See + +[`conversations.declineSharedInvite` API reference](https://api.slack.com/methods/conversations.declineSharedInvite). + +#### externalInvitePermissions + +```ts +externalInvitePermissions: object; +``` + +#### externalInvitePermissions.set + +```ts +set: Method; +``` + +##### Description + +Convert a team in a shared channel from an External Limited channel to a fully shared Slack +Connect channel or vice versa. + +##### See + +[`conversations.externalInvitePermissions.set` API reference](https://api.slack.com/methods/conversations.externalInvitePermissions.set). + +#### history + +```ts +history: Method; +``` + +##### Description + +Fetches a conversation's history of messages and events. + +##### See + +[`conversations.history` API reference](https://api.slack.com/methods/conversations.history). + +#### info + +```ts +info: Method; +``` + +##### Description + +Retrieve information about a conversation. + +##### See + +[`conversations.info` API reference](https://api.slack.com/methods/conversations.info). + +#### invite + +```ts +invite: Method; +``` + +##### Description + +Invites users to a channel. + +##### See + +[`conversations.invite` API reference](https://api.slack.com/methods/conversations.invite). + +#### inviteShared + +```ts +inviteShared: Method; +``` + +##### Description + +Sends an invitation to a Slack Connect channel. + +##### See + +[`conversations.inviteShared` API reference](https://api.slack.com/methods/conversations.inviteShared). + +#### join + +```ts +join: Method; +``` + +##### Description + +Joins an existing conversation. + +##### See + +[`conversations.join` API reference](https://api.slack.com/methods/conversations.join). + +#### kick + +```ts +kick: Method; +``` + +##### Description + +Removes a user from a conversation. + +##### See + +[`conversations.kick` API reference](https://api.slack.com/methods/conversations.kick). + +#### leave + +```ts +leave: Method; +``` + +##### Description + +Leaves a conversation. + +##### See + +[`conversations.leave` API reference](https://api.slack.com/methods/conversations.leave). + +#### list + +```ts +list: Method; +``` + +##### Description + +List all channels in a Slack team. + +##### See + +[`conversations.list` API reference](https://api.slack.com/methods/conversations.list). + +#### listConnectInvites + +```ts +listConnectInvites: Method; +``` + +##### Description + +Lists shared channel invites that have been generated or received but have not been approved by +all parties. + +##### See + +[`conversations.listConnectInvites` API reference](https://api.slack.com/methods/conversations.listConnectInvites). + +#### mark + +```ts +mark: Method; +``` + +##### Description + +Sets the read cursor in a channel. + +##### See + +[`conversations.mark` API reference](https://api.slack.com/methods/conversations.mark). + +#### members + +```ts +members: Method; +``` + +##### Description + +Retrieve members of a conversation. + +##### See + +[`conversations.members` API reference](https://api.slack.com/methods/conversations.members). + +#### open + +```ts +open: Method; +``` + +##### Description + +Opens or resumes a direct message or multi-person direct message. + +##### See + +[`conversations.open` API reference](https://api.slack.com/methods/conversations.open). + +#### rename + +```ts +rename: Method; +``` + +##### Description + +Renames a conversation. + +##### See + +[`conversations.rename` API reference](https://api.slack.com/methods/conversations.rename). + +#### replies + +```ts +replies: Method; +``` + +##### Description + +Retrieve a thread of messages posted to a conversation. + +##### See + +[`conversations.replies` API reference](https://api.slack.com/methods/conversations.replies). + +#### setPurpose + +```ts +setPurpose: Method; +``` + +##### Description + +Sets the purpose for a conversation. + +##### See + +[`conversations.setPurpose` API reference](https://api.slack.com/methods/conversations.setPurpose). + +#### setTopic + +```ts +setTopic: Method; +``` + +##### Description + +Sets the topic for a conversation. + +##### See + +[`conversations.setTopic` API reference](https://api.slack.com/methods/conversations.setTopic). + +#### unarchive + +```ts +unarchive: Method; +``` + +##### Description + +Reverses conversation archival. + +##### See + +[`conversations.unarchive` API reference](https://api.slack.com/methods/conversations.unarchive). + +#### Inherited from + +[`Methods`](Methods.md).[`conversations`](Methods.md#conversations-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1463) + +*** + +### dialog + +```ts +readonly dialog: object; +``` + +#### open + +```ts +open: Method; +``` + +##### Description + +Open a dialog with a user. + +##### See + +[`dialog.open` API reference](https://api.slack.com/methods/dialog.open). + +#### Inherited from + +[`Methods`](Methods.md).[`dialog`](Methods.md#dialog) + +#### Defined in + +[packages/web-api/src/methods.ts:1622](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1622) + +*** + +### dnd + +```ts +readonly dnd: object; +``` + +#### endDnd + +```ts +endDnd: Method; +``` + +##### Description + +Ends the current user's Do Not Disturb session immediately. + +##### See + +[`dnd.endDnd` API reference](https://api.slack.com/methods/dnd.endDnd). + +#### endSnooze + +```ts +endSnooze: Method; +``` + +##### Description + +Ends the current user's snooze mode immediately. + +##### See + +[`dnd.endSnooze` API reference](https://api.slack.com/methods/dnd.endSnooze). + +#### info + +```ts +info: Method; +``` + +##### Description + +Retrieves a user's current Do Not Disturb status. + +##### See + +[`dnd.info` API reference](https://api.slack.com/methods/dnd.info). + +#### setSnooze + +```ts +setSnooze: Method; +``` + +##### Description + +Turns on Do Not Disturb mode for the current user, or changes its duration. + +##### See + +[`dnd.setSnooze` API reference](https://api.slack.com/methods/dnd.setSnooze). + +#### teamInfo + +```ts +teamInfo: Method; +``` + +##### Description + +Retrieves the Do Not Disturb status for up to 50 users on a team. + +##### See + +[`dnd.teamInfo` API reference](https://api.slack.com/methods/dnd.teamInfo). + +#### Inherited from + +[`Methods`](Methods.md).[`dnd`](Methods.md#dnd) + +#### Defined in + +[packages/web-api/src/methods.ts:1630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1630) + +*** + +### emoji + +```ts +readonly emoji: object; +``` + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists custom emoji for a team. + +##### See + +[`emoji.list` API reference](https://api.slack.com/methods/emoji.list). + +#### Inherited from + +[`Methods`](Methods.md).[`emoji`](Methods.md#emoji-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1658) + +*** + +### files + +```ts +readonly files: object; +``` + +#### comments + +```ts +comments: object; +``` + +#### comments.delete + +```ts +delete: Method; +``` + +##### Description + +Deletes an existing comment on a file. + +##### See + +[`files.comments.delete` API reference](https://api.slack.com/methods/files.comments.delete). + +#### completeUploadExternal + +```ts +completeUploadExternal: Method; +``` + +##### Description + +Finishes an upload started with [`files.getUploadURLExternal`](https://api.slack.com/methods/files.getUploadURLExternal). + +##### See + +[`files.completeUploadExternal` API reference](https://api.slack.com/methods/files.completeUploadExternal). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a file. + +##### See + +[`files.delete` API reference](https://api.slack.com/methods/files.delete). + +#### getUploadURLExternal + +```ts +getUploadURLExternal: Method; +``` + +##### Description + +Gets a URL for an edge external file upload. + +##### See + +[`files.getUploadURLExternal` API reference](https://api.slack.com/methods/files.getUploadURLExternal). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a file. + +##### See + +[`files.info` API reference](https://api.slack.com/methods/files.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +List files for a team, in a channel, or from a user with applied filters. + +##### See + +[`files.list` API reference](https://api.slack.com/methods/files.list). + +#### remote + +```ts +remote: object; +``` + +#### remote.add + +```ts +add: Method; +``` + +##### Description + +Adds a file from a remote service. + +##### See + +[`files.remote.add` API reference](https://api.slack.com/methods/files.remote.add). + +#### remote.info + +```ts +info: Method; +``` + +##### Description + +Retrieve information about a remote file added to Slack. + +##### See + +[`files.remote.info` API reference](https://api.slack.com/methods/files.remote.info). + +#### remote.list + +```ts +list: Method; +``` + +##### Description + +List remote files added to Slack. + +##### See + +[`files.remote.list` API reference](https://api.slack.com/methods/files.remote.list). + +#### remote.remove + +```ts +remove: Method; +``` + +##### Description + +Remove a remote file. + +##### See + +[`files.remote.remove` API reference](https://api.slack.com/methods/files.remote.remove). + +#### remote.share + +```ts +share: Method; +``` + +##### Description + +Share a remote file into a channel. + +##### See + +[`files.remote.share` API reference](https://api.slack.com/methods/files.remote.share). + +#### remote.update + +```ts +update: Method; +``` + +##### Description + +Updates an existing remote file. + +##### See + +[`files.remote.update` API reference](https://api.slack.com/methods/files.remote.update). + +#### revokePublicURL + +```ts +revokePublicURL: Method; +``` + +##### Description + +Revokes public/external sharing access for a file. + +##### See + +[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). + +#### sharedPublicURL + +```ts +sharedPublicURL: Method; +``` + +##### Description + +Enables a file for public/external sharing. + +##### See + +[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). + +#### ~~upload~~ + +```ts +upload: Method; +``` + +##### Description + +Uploads or creates a file. + +##### Deprecated + +Use `uploadV2` instead. See [our post on retiring `files.upload`](https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay). + +##### See + +[`files.upload` API reference](https://api.slack.com/methods/files.upload). + +#### uploadV2 + +```ts +uploadV2: Method; +``` + +##### Description + +Custom method to support a new way of uploading files to Slack. +Supports a single file upload +Supply: +- (required) single file or content +- (optional) channel, alt_text, snippet_type, +Supports multiple file uploads +Supply: +- multiple upload_files +Will try to honor both single file or content data supplied as well +as multiple file uploads property. + +##### See + +[`@slack/web-api` Upload a file documentation](https://slack.dev/node-slack-sdk/web-api#upload-a-file). + +#### Inherited from + +[`Methods`](Methods.md).[`files`](Methods.md#files) + +#### Defined in + +[packages/web-api/src/methods.ts:1666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1666) + +*** + +### functions + +```ts +readonly functions: object; +``` + +#### completeError + +```ts +completeError: Method; +``` + +##### Description + +Signal the failure to execute a Custom Function. + +##### See + +[`functions.completeError` API reference](https://api.slack.com/methods/functions.completeError). + +#### completeSuccess + +```ts +completeSuccess: Method; +``` + +##### Description + +Signal the successful completion of a Custom Function. + +##### See + +[`functions.completeSuccess` API reference](https://api.slack.com/methods/functions.completeSuccess). + +#### Inherited from + +[`Methods`](Methods.md).[`functions`](Methods.md#functions-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1767) + +*** + +### migration + +```ts +readonly migration: object; +``` + +#### exchange + +```ts +exchange: Method; +``` + +##### Description + +For Enterprise Grid workspaces, map local user IDs to global user IDs. + +##### See + +[`migration.exchange` API reference](https://api.slack.com/methods/migration.exchange). + +#### Inherited from + +[`Methods`](Methods.md).[`migration`](Methods.md#migration) + +#### Defined in + +[packages/web-api/src/methods.ts:1783](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1783) + +*** + +### oauth + +```ts +readonly oauth: object; +``` + +#### ~~access~~ + +```ts +access: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token. + +##### Deprecated + +This is a legacy method only used by classic Slack apps. Use `oauth.v2.access` for new Slack apps. + +##### See + +[`oauth.access` API reference](https://api.slack.com/methods/oauth.access). + +#### v2 + +```ts +v2: object; +``` + +#### v2.access + +```ts +access: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token. + +##### See + +[`oauth.v2.access` API reference](https://api.slack.com/methods/oauth.v2.access). + +#### v2.exchange + +```ts +exchange: Method; +``` + +##### Description + +Exchanges a legacy access token for a new expiring access token and refresh token. + +##### See + +[`oauth.v2.exchange` API reference](https://api.slack.com/methods/oauth.v2.exchange). + +#### Inherited from + +[`Methods`](Methods.md).[`oauth`](Methods.md#oauth) + +#### Defined in + +[packages/web-api/src/methods.ts:1791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1791) + +*** + +### openid + +```ts +readonly openid: object; +``` + +#### connect + +```ts +connect: object; +``` + +#### connect.token + +```ts +token: Method; +``` + +##### Description + +Exchanges a temporary OAuth verifier code for an access token for [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). + +##### See + +[`openid.connect.token` API reference](https://api.slack.com/methods/openid.connect.token). + +#### connect.userInfo + +```ts +userInfo: Method; +``` + +##### Description + +Get the identity of a user who has authorized [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). + +##### See + +[`openid.connect.userInfo` API reference](https://api.slack.com/methods/openid.connect.userInfo). + +#### Inherited from + +[`Methods`](Methods.md).[`openid`](Methods.md#openid) + +#### Defined in + +[packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) + +*** + +### pins + +```ts +readonly pins: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Pins an item to a channel. + +##### See + +[`pins.add` API reference](https://api.slack.com/methods/pins.add). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists items pinned to a channel. + +##### See + +[`pins.list` API reference](https://api.slack.com/methods/pins.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Un-pins an item from a channel. + +##### See + +[`pins.remove` API reference](https://api.slack.com/methods/pins.remove). + +#### Inherited from + +[`Methods`](Methods.md).[`pins`](Methods.md#pins) + +#### Defined in + +[packages/web-api/src/methods.ts:1827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1827) + +*** + +### reactions + +```ts +readonly reactions: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Adds a reaction to an item. + +##### See + +[`reactions.add` API reference](https://api.slack.com/methods/reactions.add). + +#### get + +```ts +get: Method; +``` + +##### Description + +Gets reactions for an item. + +##### See + +[`reactions.get` API reference](https://api.slack.com/methods/reactions.get). + +#### list + +```ts +list: Method; +``` + +##### Description + +List reactions made by a user. + +##### See + +[`reactions.list` API reference](https://api.slack.com/methods/reactions.list). + +#### remove + +```ts +remove: Method; +``` + +##### Description + +Removes a reaction from an item. + +##### See + +[`reactions.remove` API reference](https://api.slack.com/methods/reactions.remove). + +#### Inherited from + +[`Methods`](Methods.md).[`reactions`](Methods.md#reactions) + +#### Defined in + +[packages/web-api/src/methods.ts:1845](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1845) + +*** + +### reminders + +```ts +readonly reminders: object; +``` + +#### add + +```ts +add: Method; +``` + +##### Description + +Creates a reminder. + +##### See + +[`reminders.add` API reference](https://api.slack.com/methods/reminders.add). + +#### complete + +```ts +complete: Method; +``` + +##### Description + +Marks a reminder as complete. + +##### See + +[`reminders.complete` API reference](https://api.slack.com/methods/reminders.complete). + +#### delete + +```ts +delete: Method; +``` + +##### Description + +Deletes a reminder. + +##### See + +[`reminders.delete` API reference](https://api.slack.com/methods/reminders.delete). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a reminder. + +##### See + +[`reminders.info` API reference](https://api.slack.com/methods/reminders.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists all reminders created by or for a given user. + +##### See + +[`reminders.list` API reference](https://api.slack.com/methods/reminders.list). + +#### Inherited from + +[`Methods`](Methods.md).[`reminders`](Methods.md#reminders) + +#### Defined in + +[packages/web-api/src/methods.ts:1870](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1870) + +*** + +### rtm + +```ts +readonly rtm: object; +``` + +#### connect + +```ts +connect: Method; +``` + +##### Description + +Starts a Real Time Messaging session. + +##### See + +[`rtm.connect` API reference](https://api.slack.com/methods/rtm.connect). + +#### ~~start~~ + +```ts +start: Method; +``` + +##### Description + +Starts a Real Time Messaging session. + +##### Deprecated + +Use `rtm.connect` instead. See [our post on retiring `rtm.start`](https://api.slack.com/changelog/2021-10-rtm-start-to-stop). + +##### See + +[`rtm.start` API reference](https://api.slack.com/methods/rtm.start). + +#### Inherited from + +[`Methods`](Methods.md).[`rtm`](Methods.md#rtm) + +#### Defined in + +[packages/web-api/src/methods.ts:1898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1898) + +*** + +### search + +```ts +readonly search: object; +``` + +#### all + +```ts +all: Method; +``` + +##### Description + +Searches for messages and files matching a query. + +##### See + +[search.all` API reference](https://api.slack.com/methods/search.all). + +#### files + +```ts +files: Method; +``` + +##### Description + +Searches for files matching a query. + +##### See + +[search.files` API reference](https://api.slack.com/methods/search.files). + +#### messages + +```ts +messages: Method; +``` + +##### Description + +Searches for messages matching a query. + +##### See + +[search.messages` API reference](https://api.slack.com/methods/search.messages). + +#### Inherited from + +[`Methods`](Methods.md).[`search`](Methods.md#search-2) + +#### Defined in + +[packages/web-api/src/methods.ts:1912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1912) + +*** + +### slackApiUrl + +```ts +readonly slackApiUrl: string; +``` + +The base URL for reaching Slack's Web API. Consider changing this value for testing purposes. + +#### Defined in + +[packages/web-api/src/WebClient.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L130) + +*** + +### stars + +```ts +readonly stars: object; +``` + +#### ~~add~~ + +```ts +add: Method; +``` + +##### Description + +Save an item for later. Formerly known as adding a star. + +##### Deprecated + +Stars can still be added but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.add` API reference](https://api.slack.com/methods/stars.add). + +#### ~~list~~ + +```ts +list: Method; +``` + +##### Description + +List a user's saved items, formerly known as stars. + +##### Deprecated + +Stars can still be listed but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.list` API reference](https://api.slack.com/methods/stars.list). + +#### ~~remove~~ + +```ts +remove: Method; +``` + +##### Description + +Remove a saved item from a user's saved items, formerly known as stars. + +##### Deprecated + +Stars can still be removed but they can no longer be viewed or interacted with by end-users. +See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). + +##### See + +[`stars.remove` API reference](https://api.slack.com/methods/stars.remove). + +#### Inherited from + +[`Methods`](Methods.md).[`stars`](Methods.md#stars) + +#### Defined in + +[packages/web-api/src/methods.ts:2140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2140) + +*** + +### team + +```ts +readonly team: object; +``` + +#### accessLogs + +```ts +accessLogs: Method; +``` + +##### Description + +Gets the access logs for the current team. + +##### See + +[`team.accessLogs` API reference](https://api.slack.com/methods/team.accessLogs). + +#### billableInfo + +```ts +billableInfo: Method; +``` + +##### Description + +Gets billable users information for the current team. + +##### See + +[`team.billableInfo` API reference](https://api.slack.com/methods/team.billableInfo). + +#### billing + +```ts +billing: object; +``` + +#### billing.info + +```ts +info: Method; +``` + +##### Description + +Reads a workspace's billing plan information. + +##### See + +[`team.billing.info` API reference](https://api.slack.com/methods/team.billing.info). + +#### externalTeams + +```ts +externalTeams: object; +``` + +#### externalTeams.disconnect + +```ts +disconnect: Method; +``` + +##### Description + +Disconnect an external organization. + +##### See + +[`team.externalTeams.disconnect` API reference](https://api.slack.com/methods/team.externalTeams.disconnect). + +#### externalTeams.list + +```ts +list: Method; +``` + +##### Description + +Returns a list of all the external teams connected and details about the connection. + +##### See + +[`team.externalTeams.list` API reference](https://api.slack.com/methods/team.externalTeams.list). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about the current team. + +##### See + +[`team.info` API reference](https://api.slack.com/methods/team.info). + +#### integrationLogs + +```ts +integrationLogs: Method; +``` + +##### Description + +Gets the integration logs for the current team. + +##### See + +[`team.integrationLogs` API reference](https://api.slack.com/methods/team.integrationLogs). + +#### preferences + +```ts +preferences: object; +``` + +#### preferences.list + +```ts +list: Method; +``` + +##### Description + +Retrieve a list of a workspace's team preferences. + +##### See + +[`team.preferences.list` API reference](https://api.slack.com/methods/team.preferences.list). + +#### profile + +```ts +profile: object; +``` + +#### profile.get + +```ts +get: Method; +``` + +##### Description + +Retrieve a team's profile. + +##### See + +[`team.profile.get` API reference](https://api.slack.com/methods/team.profile.get). + +#### Inherited from + +[`Methods`](Methods.md).[`team`](Methods.md#team) + +#### Defined in + +[packages/web-api/src/methods.ts:1930](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1930) + +*** + +### token? + +```ts +readonly optional token: string; +``` + +Authentication and authorization token for accessing Slack Web API (usually begins with `xoxp` or `xoxb`) + +#### Defined in + +[packages/web-api/src/WebClient.ts:135](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L135) + +*** + +### tooling + +```ts +readonly tooling: object; +``` + +#### tokens + +```ts +tokens: object; +``` + +#### tokens.rotate + +```ts +rotate: Method; +``` + +##### Description + +Exchanges a refresh token for a new app configuration token. + +##### See + +[`tooling.tokens.rotate` API reference](https://api.slack.com/methods/tooling.tokens.rotate). + +#### Inherited from + +[`Methods`](Methods.md).[`tooling`](Methods.md#tooling) + +#### Defined in + +[packages/web-api/src/methods.ts:1987](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1987) + +*** + +### usergroups + +```ts +readonly usergroups: object; +``` + +#### create + +```ts +create: Method; +``` + +##### Description + +Create a User Group. + +##### See + +[`usergroups.create` API reference](https://api.slack.com/methods/usergroups.create). + +#### disable + +```ts +disable: Method; +``` + +##### Description + +Disable an existing User Group. + +##### See + +[`usergroups.disable` API reference](https://api.slack.com/methods/usergroups.disable). + +#### enable + +```ts +enable: Method; +``` + +##### Description + +Enable an existing User Group. + +##### See + +[`usergroups.enable` API reference](https://api.slack.com/methods/usergroups.enable). + +#### list + +```ts +list: Method; +``` + +##### Description + +List all User Groups for a team. + +##### See + +[`usergroups.list` API reference](https://api.slack.com/methods/usergroups.list). + +#### update + +```ts +update: Method; +``` + +##### Description + +Update an existing User Group. + +##### See + +[`usergroups.update` API reference](https://api.slack.com/methods/usergroups.update). + +#### users + +```ts +users: object; +``` + +#### users.list + +```ts +list: Method; +``` + +##### Description + +List all users in a User Group. + +##### See + +[`usergroups.users.list` API reference](https://api.slack.com/methods/usergroups.users.list). + +#### users.update + +```ts +update: Method; +``` + +##### Description + +Update the list of users in a User Group. + +##### See + +[`usergroups.users.update` API reference](https://api.slack.com/methods/usergroups.users.update). + +#### Inherited from + +[`Methods`](Methods.md).[`usergroups`](Methods.md#usergroups-1) + +#### Defined in + +[packages/web-api/src/methods.ts:1997](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1997) + +*** + +### users + +```ts +readonly users: object; +``` + +#### conversations + +```ts +conversations: Method; +``` + +##### Description + +List conversations the calling user may access. + +##### See + +[`users.conversations` API reference](https://api.slack.com/methods/users.conversations). + +#### deletePhoto + +```ts +deletePhoto: Method; +``` + +##### Description + +Delete the user profile photo. + +##### See + +[`users.deletePhoto` API reference](https://api.slack.com/methods/users.deletePhoto). + +#### discoverableContacts + +```ts +discoverableContacts: object; +``` + +#### discoverableContacts.lookup + +```ts +lookup: Method; +``` + +##### Description + +Lookup an email address to see if someone is on Slack. + +##### See + +[`users.discoverableContacts.lookup` API reference](https://api.slack.com/methods/users.discoverableContacts.lookup). + +#### getPresence + +```ts +getPresence: Method; +``` + +##### Description + +Gets user presence information. + +##### See + +[`users.getPresence` API reference](https://api.slack.com/methods/users.getPresence). + +#### identity + +```ts +identity: Method; +``` + +##### Description + +Get a user's identity. + +##### See + +[`users.identity` API reference](https://api.slack.com/methods/users.identity). + +#### info + +```ts +info: Method; +``` + +##### Description + +Gets information about a user. + +##### See + +[`users.info` API reference](https://api.slack.com/methods/users.info). + +#### list + +```ts +list: Method; +``` + +##### Description + +Lists all users in a Slack team. + +##### See + +[`users.list` API reference](https://api.slack.com/methods/users.list). + +#### lookupByEmail + +```ts +lookupByEmail: Method; +``` + +##### Description + +Find a user with an email address. + +##### See + +[`users.lookupByEmail` API reference](https://api.slack.com/methods/users.lookupByEmail). + +#### profile + +```ts +profile: object; +``` + +#### profile.get + +```ts +get: Method; +``` + +##### Description + +Retrieve a user's profile information, including their custom status. + +##### See + +[`users.profile.get` API reference](https://api.slack.com/methods/users.profile.get). + +#### profile.set + +```ts +set: Method; +``` + +##### Description + +Set a user's profile information, including custom status. + +##### See + +[`users.profile.set` API reference](https://api.slack.com/methods/users.profile.set). + +#### setPhoto + +```ts +setPhoto: Method; +``` + +##### Description + +Set the user profile photo. + +##### See + +[`users.setPhoto` API reference](https://api.slack.com/methods/users.setPhoto). + +#### setPresence + +```ts +setPresence: Method; +``` + +##### Description + +Manually sets user presence. + +##### See + +[`users.setPresence` API reference](https://api.slack.com/methods/users.setPresence). + +#### Inherited from + +[`Methods`](Methods.md).[`users`](Methods.md#users-2) + +#### Defined in + +[packages/web-api/src/methods.ts:2043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2043) + +*** + +### views + +```ts +readonly views: object; +``` + +#### open + +```ts +open: Method; +``` + +##### Description + +Open a view for a user. + +##### See + +[`views.open` API reference](https://api.slack.com/methods/views.open). + +#### publish + +```ts +publish: Method; +``` + +##### Description + +Publish a static view for a user. + +##### See + +[`views.publish` API reference](https://api.slack.com/methods/views.publish). + +#### push + +```ts +push: Method; +``` + +##### Description + +Push a view onto the stack of a root view. + +##### See + +[`views.push` API reference](https://api.slack.com/methods/views.push). + +#### update + +```ts +update: Method; +``` + +##### Description + +Update an existing view. + +##### See + +[`views.update` API reference](https://api.slack.com/methods/views.update). + +#### Inherited from + +[`Methods`](Methods.md).[`views`](Methods.md#views) + +#### Defined in + +[packages/web-api/src/methods.ts:2110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2110) + +*** + +### workflows + +```ts +readonly workflows: object; +``` + +#### ~~stepCompleted~~ + +```ts +stepCompleted: Method; +``` + +##### Description + +Indicate that an app's step in a workflow completed execution. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.stepCompleted` API reference](https://api.slack.com/methods/workflows.stepCompleted). + +#### ~~stepFailed~~ + +```ts +stepFailed: Method; +``` + +##### Description + +Indicate that an app's step in a workflow failed to execute. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.stepFailed` API reference](https://api.slack.com/methods/workflows.stepFailed). + +#### ~~updateStep~~ + +```ts +updateStep: Method; +``` + +##### Description + +Update the configuration for a workflow step. + +##### Deprecated + +Steps from Apps is deprecated. +We're retiring all Slack app functionality around Steps from Apps in September 2024. +See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +##### See + +[`workflows.updateStep` API reference](https://api.slack.com/methods/workflows.updateStep). + +#### Inherited from + +[`Methods`](Methods.md).[`workflows`](Methods.md#workflows-1) + +#### Defined in + +[packages/web-api/src/methods.ts:2164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2164) + +*** + +### prefixed + +```ts +static prefixed: string | boolean; +``` + +#### Inherited from + +[`Methods`](Methods.md).[`prefixed`](Methods.md#prefixed) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:9 + +## Methods + +### addListener() + +```ts +addListener( + event, + fn, + context?): this +``` + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`addListener`](Methods.md#addlistener) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:45 + +*** + +### apiCall() + +```ts +apiCall(method, options): Promise +``` + +Generic method for calling a Web API method + +#### Parameters + +• **method**: `string` + +the Web API method to call [https://api.slack.com/methods](https://api.slack.com/methods) + +• **options**: `Record`\<`string`, `unknown`\> = `{}` + +options + +#### Returns + +`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> + +#### Overrides + +[`Methods`](Methods.md).[`apiCall`](Methods.md#apicall) + +#### Defined in + +[packages/web-api/src/WebClient.ts:255](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L255) + +*** + +### emit() + +```ts +emit(event, ...args): boolean +``` + +Calls each of the listeners registered for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• ...**args**: `any`[] + +#### Returns + +`boolean` + +#### Inherited from + +[`Methods`](Methods.md).[`emit`](Methods.md#emit) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:32 + +*** + +### eventNames() + +```ts +eventNames(): RATE_LIMITED[] +``` + +Return an array listing the events for which the emitter has registered +listeners. + +#### Returns + +[`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited)[] + +#### Inherited from + +[`Methods`](Methods.md).[`eventNames`](Methods.md#eventnames) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:15 + +*** + +### filesUploadV2() + +```ts +filesUploadV2(options): Promise +``` + +This wrapper method provides an easy way to upload files using the following endpoints: + +**#1**: For each file submitted with this method, submit filenames +and file metadata to [files.getUploadURLExternal](https://api.slack.com/methods/files.getUploadURLExternal) to request a URL to +which to send the file data to and an id for the file + +**#2**: for each returned file `upload_url`, upload corresponding file to +URLs returned from step 1 (e.g. https://files.slack.com/upload/v1/...\") + +**#3**: Complete uploads [files.completeUploadExternal](https://api.slack.com/methods/files.completeUploadExternal) + +#### Parameters + +• **options**: [`FilesUploadV2Arguments`](../type-aliases/FilesUploadV2Arguments.md) + +#### Returns + +`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md) & `object`\> + +#### Overrides + +[`Methods`](Methods.md).[`filesUploadV2`](Methods.md#filesuploadv2) + +#### Defined in + +[packages/web-api/src/WebClient.ts:436](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L436) + +*** + +### listenerCount() + +```ts +listenerCount(event): number +``` + +Return the number of listeners listening to a given event. + +#### Parameters + +• **event**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Returns + +`number` + +#### Inherited from + +[`Methods`](Methods.md).[`listenerCount`](Methods.md#listenercount) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:27 + +*** + +### listeners() + +```ts +listeners(event): (...args) => void[] +``` + +Return the listeners registered for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +#### Returns + +(...`args`) => `void`[] + +#### Inherited from + +[`Methods`](Methods.md).[`listeners`](Methods.md#listeners) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:20 + +*** + +### off() + +```ts +off( + event, + fn?, + context?, + once?): this +``` + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn?** + +• **context?**: `any` + +• **once?**: `boolean` + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`off`](Methods.md#off) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:69 + +*** + +### on() + +```ts +on( + event, + fn, + context?): this +``` + +Add a listener for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`on`](Methods.md#on) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:40 + +*** + +### once() + +```ts +once( + event, + fn, + context?): this +``` + +Add a one-time listener for a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn** + +• **context?**: `any` + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`once`](Methods.md#once) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:54 + +*** + +### paginate() + +#### paginate(method, options) + +```ts +paginate(method, options?): AsyncIterable +``` + +Iterate over the result pages of a cursor-paginated Web API method. This method can return two types of values, +depending on which arguments are used. When up to two parameters are used, the return value is an async iterator +which can be used as the iterable in a for-await-of loop. When three or four parameters are used, the return +value is a promise that resolves at the end of iteration. The third parameter, `shouldStop`, is a function that is +called with each `page` and can end iteration by returning `true`. The fourth parameter, `reduce`, is a function +that is called with three arguments: `accumulator`, `page`, and `index`. The `accumulator` is a value of any type +you choose, but it will contain `undefined` when `reduce` is called for the first time. The `page` argument and +`index` arguments are exactly what they say they are. The `reduce` function's return value will be passed in as +`accumulator` the next time its called, and the returned promise will resolve to the last value of `accumulator`. + +The for-await-of syntax is part of ES2018. It is available natively in Node starting with v10.0.0. You may be able +to use it in earlier JavaScript runtimes by transpiling your source with a tool like Babel. However, the +transpiled code will likely sacrifice performance. + +##### Parameters + +• **method**: `string` + +the cursor-paginated Web API method to call [https://api.slack.com/docs/pagination](https://api.slack.com/docs/pagination) + +• **options?**: `Record`\<`string`, `unknown`\> + +options + +##### Returns + +`AsyncIterable`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> + +##### Defined in + +[packages/web-api/src/WebClient.ts:337](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L337) + +#### paginate(method, options, shouldStop) + +```ts +paginate( + method, + options, +shouldStop): Promise +``` + +##### Parameters + +• **method**: `string` + +• **options**: `Record`\<`string`, `unknown`\> + +• **shouldStop**: [`PaginatePredicate`](../interfaces/PaginatePredicate.md) + +##### Returns + +`Promise`\<`void`\> + +##### Defined in + +[packages/web-api/src/WebClient.ts:338](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L338) + +#### paginate(method, options, shouldStop, reduce) + +```ts +paginate( + method, + options, + shouldStop, +reduce?): Promise +``` + +##### Type Parameters + +• **R** *extends* [`PageReducer`](../interfaces/PageReducer.md)\<`any`\> + +• **A** *extends* `any` + +##### Parameters + +• **method**: `string` + +• **options**: `Record`\<`string`, `unknown`\> + +• **shouldStop**: [`PaginatePredicate`](../interfaces/PaginatePredicate.md) + +• **reduce?**: [`PageReducer`](../interfaces/PageReducer.md)\<`A`\> + +##### Returns + +`Promise`\<`A`\> + +##### Defined in + +[packages/web-api/src/WebClient.ts:343](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L343) + +*** + +### removeAllListeners() + +```ts +removeAllListeners(event?): this +``` + +Remove all listeners, or those of the specified event. + +#### Parameters + +• **event?**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`removeAllListeners`](Methods.md#removealllisteners) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:79 + +*** + +### removeListener() + +```ts +removeListener( + event, + fn?, + context?, + once?): this +``` + +Remove the listeners of a given event. + +#### Type Parameters + +• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) + +#### Parameters + +• **event**: `T` + +• **fn?** + +• **context?**: `any` + +• **once?**: `boolean` + +#### Returns + +`this` + +#### Inherited from + +[`Methods`](Methods.md).[`removeListener`](Methods.md#removelistener) + +#### Defined in + +packages/web-api/node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/content/reference/web-api/enumerations/ErrorCode.md b/docs/content/reference/web-api/enumerations/ErrorCode.md new file mode 100644 index 000000000..e1def4210 --- /dev/null +++ b/docs/content/reference/web-api/enumerations/ErrorCode.md @@ -0,0 +1,75 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package + +## Enumeration Members + +### FileUploadInvalidArgumentsError + +```ts +FileUploadInvalidArgumentsError: "slack_webapi_file_upload_invalid_args_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L25) + +*** + +### FileUploadReadFileDataError + +```ts +FileUploadReadFileDataError: "slack_webapi_file_upload_read_file_data_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L26) + +*** + +### HTTPError + +```ts +HTTPError: "slack_webapi_http_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L20) + +*** + +### PlatformError + +```ts +PlatformError: "slack_webapi_platform_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L21) + +*** + +### RateLimitedError + +```ts +RateLimitedError: "slack_webapi_rate_limited_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L22) + +*** + +### RequestError + +```ts +RequestError: "slack_webapi_request_error"; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L19) diff --git a/docs/content/reference/web-api/enumerations/LogLevel.md b/docs/content/reference/web-api/enumerations/LogLevel.md new file mode 100644 index 000000000..17a5c7761 --- /dev/null +++ b/docs/content/reference/web-api/enumerations/LogLevel.md @@ -0,0 +1,51 @@ +# Enumeration: LogLevel + +Severity levels for log entries + +## Enumeration Members + +### DEBUG + +```ts +DEBUG: "debug"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:8 + +*** + +### ERROR + +```ts +ERROR: "error"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:5 + +*** + +### INFO + +```ts +INFO: "info"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:7 + +*** + +### WARN + +```ts +WARN: "warn"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:6 diff --git a/docs/content/reference/web-api/enumerations/WebClientEvent.md b/docs/content/reference/web-api/enumerations/WebClientEvent.md new file mode 100644 index 000000000..9b3394cab --- /dev/null +++ b/docs/content/reference/web-api/enumerations/WebClientEvent.md @@ -0,0 +1,13 @@ +# Enumeration: WebClientEvent + +## Enumeration Members + +### RATE\_LIMITED + +```ts +RATE_LIMITED: "rate_limited"; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L88) diff --git a/docs/content/reference/web-api/functions/addAppMetadata.md b/docs/content/reference/web-api/functions/addAppMetadata.md new file mode 100644 index 000000000..de58a5538 --- /dev/null +++ b/docs/content/reference/web-api/functions/addAppMetadata.md @@ -0,0 +1,23 @@ +# Function: addAppMetadata() + +```ts +function addAppMetadata(__namedParameters): void +``` + +Appends the app metadata into the User-Agent value + +## Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.name**: `string` + +• **\_\_namedParameters.version**: `string` + +## Returns + +`void` + +## Defined in + +[packages/web-api/src/instrument.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/instrument.ts#L31) diff --git a/docs/content/reference/web-api/index.md b/docs/content/reference/web-api/index.md new file mode 100644 index 000000000..30b89547b --- /dev/null +++ b/docs/content/reference/web-api/index.md @@ -0,0 +1,683 @@ +# @slack/web-api + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) +- [LogLevel](enumerations/LogLevel.md) +- [WebClientEvent](enumerations/WebClientEvent.md) + +## Classes + +- [Methods](classes/Methods.md) +- [WebClient](classes/WebClient.md) + +## Interfaces + +- [Action](interfaces/Action.md) +- [Actionable](interfaces/Actionable.md) +- [ActionsBlock](interfaces/ActionsBlock.md) +- [AdminAnalyticsMemberDetails](interfaces/AdminAnalyticsMemberDetails.md) +- [AdminAnalyticsPublicChannelDetails](interfaces/AdminAnalyticsPublicChannelDetails.md) +- [AdminAnalyticsPublicChannelMetadataDetails](interfaces/AdminAnalyticsPublicChannelMetadataDetails.md) +- [AdminAppsConfigLookupArguments](interfaces/AdminAppsConfigLookupArguments.md) +- [AdminAppsConfigSetArguments](interfaces/AdminAppsConfigSetArguments.md) +- [AdminAuthPolicyAssignEntitiesArguments](interfaces/AdminAuthPolicyAssignEntitiesArguments.md) +- [AdminAuthPolicyGetEntitiesArguments](interfaces/AdminAuthPolicyGetEntitiesArguments.md) +- [AdminAuthPolicyRemoveEntitiesArguments](interfaces/AdminAuthPolicyRemoveEntitiesArguments.md) +- [AdminBarriersCreateArguments](interfaces/AdminBarriersCreateArguments.md) +- [AdminBarriersDeleteArguments](interfaces/AdminBarriersDeleteArguments.md) +- [AdminBarriersUpdateArguments](interfaces/AdminBarriersUpdateArguments.md) +- [AdminConversationsArchiveArguments](interfaces/AdminConversationsArchiveArguments.md) +- [AdminConversationsBulkArchiveArguments](interfaces/AdminConversationsBulkArchiveArguments.md) +- [AdminConversationsBulkDeleteArguments](interfaces/AdminConversationsBulkDeleteArguments.md) +- [AdminConversationsBulkMoveArguments](interfaces/AdminConversationsBulkMoveArguments.md) +- [AdminConversationsConvertToPrivateArguments](interfaces/AdminConversationsConvertToPrivateArguments.md) +- [AdminConversationsConvertToPublicArguments](interfaces/AdminConversationsConvertToPublicArguments.md) +- [AdminConversationsDeleteArguments](interfaces/AdminConversationsDeleteArguments.md) +- [AdminConversationsDisconnectSharedArguments](interfaces/AdminConversationsDisconnectSharedArguments.md) +- [AdminConversationsGetConversationPrefsArguments](interfaces/AdminConversationsGetConversationPrefsArguments.md) +- [AdminConversationsGetCustomRetentionArguments](interfaces/AdminConversationsGetCustomRetentionArguments.md) +- [AdminConversationsGetTeamsArguments](interfaces/AdminConversationsGetTeamsArguments.md) +- [AdminConversationsInviteArguments](interfaces/AdminConversationsInviteArguments.md) +- [AdminConversationsLookupArguments](interfaces/AdminConversationsLookupArguments.md) +- [AdminConversationsRemoveCustomRetentionArguments](interfaces/AdminConversationsRemoveCustomRetentionArguments.md) +- [AdminConversationsRenameArguments](interfaces/AdminConversationsRenameArguments.md) +- [AdminConversationsRestrictAccessAddGroupArguments](interfaces/AdminConversationsRestrictAccessAddGroupArguments.md) +- [AdminConversationsRestrictAccessListGroupsArguments](interfaces/AdminConversationsRestrictAccessListGroupsArguments.md) +- [AdminConversationsRestrictAccessRemoveGroupArguments](interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md) +- [AdminConversationsSetConversationPrefsArguments](interfaces/AdminConversationsSetConversationPrefsArguments.md) +- [AdminConversationsSetCustomRetentionArguments](interfaces/AdminConversationsSetCustomRetentionArguments.md) +- [AdminConversationsSetTeamsArguments](interfaces/AdminConversationsSetTeamsArguments.md) +- [AdminConversationsUnarchiveArguments](interfaces/AdminConversationsUnarchiveArguments.md) +- [AdminEmojiAddAliasArguments](interfaces/AdminEmojiAddAliasArguments.md) +- [AdminEmojiAddArguments](interfaces/AdminEmojiAddArguments.md) +- [AdminEmojiRemoveArguments](interfaces/AdminEmojiRemoveArguments.md) +- [AdminEmojiRenameArguments](interfaces/AdminEmojiRenameArguments.md) +- [AdminFunctionsListArguments](interfaces/AdminFunctionsListArguments.md) +- [AdminFunctionsPermissionsLookupArguments](interfaces/AdminFunctionsPermissionsLookupArguments.md) +- [AdminFunctionsPermissionsSetArguments](interfaces/AdminFunctionsPermissionsSetArguments.md) +- [AdminInviteRequestsApproveArguments](interfaces/AdminInviteRequestsApproveArguments.md) +- [AdminInviteRequestsApprovedListArguments](interfaces/AdminInviteRequestsApprovedListArguments.md) +- [AdminInviteRequestsDeniedListArguments](interfaces/AdminInviteRequestsDeniedListArguments.md) +- [AdminInviteRequestsDenyArguments](interfaces/AdminInviteRequestsDenyArguments.md) +- [AdminInviteRequestsListArguments](interfaces/AdminInviteRequestsListArguments.md) +- [AdminRolesAddAssignmentsArguments](interfaces/AdminRolesAddAssignmentsArguments.md) +- [AdminRolesRemoveAssignmentsArguments](interfaces/AdminRolesRemoveAssignmentsArguments.md) +- [AdminTeamsAdminsListArguments](interfaces/AdminTeamsAdminsListArguments.md) +- [AdminTeamsCreateArguments](interfaces/AdminTeamsCreateArguments.md) +- [AdminTeamsOwnersListArguments](interfaces/AdminTeamsOwnersListArguments.md) +- [AdminTeamsSettingsInfoArguments](interfaces/AdminTeamsSettingsInfoArguments.md) +- [AdminTeamsSettingsSetDefaultChannelsArguments](interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md) +- [AdminTeamsSettingsSetDescriptionArguments](interfaces/AdminTeamsSettingsSetDescriptionArguments.md) +- [AdminTeamsSettingsSetDiscoverabilityArguments](interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md) +- [AdminTeamsSettingsSetIconArguments](interfaces/AdminTeamsSettingsSetIconArguments.md) +- [AdminTeamsSettingsSetNameArguments](interfaces/AdminTeamsSettingsSetNameArguments.md) +- [AdminUsergroupsAddChannelsArguments](interfaces/AdminUsergroupsAddChannelsArguments.md) +- [AdminUsergroupsAddTeamsArguments](interfaces/AdminUsergroupsAddTeamsArguments.md) +- [AdminUsergroupsListChannelsArguments](interfaces/AdminUsergroupsListChannelsArguments.md) +- [AdminUsergroupsRemoveChannelsArguments](interfaces/AdminUsergroupsRemoveChannelsArguments.md) +- [AdminUsersAssignArguments](interfaces/AdminUsersAssignArguments.md) +- [AdminUsersInviteArguments](interfaces/AdminUsersInviteArguments.md) +- [AdminUsersRemoveArguments](interfaces/AdminUsersRemoveArguments.md) +- [AdminUsersSessionClearSettingsArguments](interfaces/AdminUsersSessionClearSettingsArguments.md) +- [AdminUsersSessionGetSettingsArguments](interfaces/AdminUsersSessionGetSettingsArguments.md) +- [AdminUsersSessionInvalidateArguments](interfaces/AdminUsersSessionInvalidateArguments.md) +- [AdminUsersSessionResetArguments](interfaces/AdminUsersSessionResetArguments.md) +- [AdminUsersSessionResetBulkArguments](interfaces/AdminUsersSessionResetBulkArguments.md) +- [AdminUsersSessionSetSettingsArguments](interfaces/AdminUsersSessionSetSettingsArguments.md) +- [AdminUsersSetAdminArguments](interfaces/AdminUsersSetAdminArguments.md) +- [AdminUsersSetExpirationArguments](interfaces/AdminUsersSetExpirationArguments.md) +- [AdminUsersSetOwnerArguments](interfaces/AdminUsersSetOwnerArguments.md) +- [AdminUsersSetRegularArguments](interfaces/AdminUsersSetRegularArguments.md) +- [AdminUsersUnsupportedVersionsExportArguments](interfaces/AdminUsersUnsupportedVersionsExportArguments.md) +- [AdminWorkflowsCollaboratorsAddArguments](interfaces/AdminWorkflowsCollaboratorsAddArguments.md) +- [AdminWorkflowsCollaboratorsRemoveArguments](interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md) +- [AdminWorkflowsPermissionsLookupArguments](interfaces/AdminWorkflowsPermissionsLookupArguments.md) +- [AdminWorkflowsUnpublishArguments](interfaces/AdminWorkflowsUnpublishArguments.md) +- [AppsEventAuthorizationsListArguments](interfaces/AppsEventAuthorizationsListArguments.md) +- [AppsManifestCreateArguments](interfaces/AppsManifestCreateArguments.md) +- [AppsManifestDeleteArguments](interfaces/AppsManifestDeleteArguments.md) +- [AppsManifestExportArguments](interfaces/AppsManifestExportArguments.md) +- [AppsManifestUpdateArguments](interfaces/AppsManifestUpdateArguments.md) +- [AppsManifestValidateArguments](interfaces/AppsManifestValidateArguments.md) +- [AppsUninstallArguments](interfaces/AppsUninstallArguments.md) +- [AttachmentAction](interfaces/AttachmentAction.md) +- [Block](interfaces/Block.md) +- [BookmarksAddArguments](interfaces/BookmarksAddArguments.md) +- [BookmarksEditArguments](interfaces/BookmarksEditArguments.md) +- [BookmarksListArguments](interfaces/BookmarksListArguments.md) +- [BookmarksRemoveArguments](interfaces/BookmarksRemoveArguments.md) +- [Button](interfaces/Button.md) +- [CallUserExternal](interfaces/CallUserExternal.md) +- [CallUserSlack](interfaces/CallUserSlack.md) +- [CallsAddArguments](interfaces/CallsAddArguments.md) +- [CallsEndArguments](interfaces/CallsEndArguments.md) +- [CallsInfoArguments](interfaces/CallsInfoArguments.md) +- [CallsParticipantsAddArguments](interfaces/CallsParticipantsAddArguments.md) +- [CallsParticipantsRemoveArguments](interfaces/CallsParticipantsRemoveArguments.md) +- [CallsUpdateArguments](interfaces/CallsUpdateArguments.md) +- [CanvasesAccessDeleteArguments](interfaces/CanvasesAccessDeleteArguments.md) +- [CanvasesAccessSetArguments](interfaces/CanvasesAccessSetArguments.md) +- [CanvasesDeleteArguments](interfaces/CanvasesDeleteArguments.md) +- [CanvasesEditArguments](interfaces/CanvasesEditArguments.md) +- [CanvasesSectionsLookupArguments](interfaces/CanvasesSectionsLookupArguments.md) +- [ChannelsSelect](interfaces/ChannelsSelect.md) +- [ChatDeleteArguments](interfaces/ChatDeleteArguments.md) +- [ChatDeleteScheduledMessageArguments](interfaces/ChatDeleteScheduledMessageArguments.md) +- [ChatGetPermalinkArguments](interfaces/ChatGetPermalinkArguments.md) +- [ChatMeMessageArguments](interfaces/ChatMeMessageArguments.md) +- [Checkboxes](interfaces/Checkboxes.md) +- [CodedError](interfaces/CodedError.md) +- [Confirm](interfaces/Confirm.md) +- [Confirmable](interfaces/Confirmable.md) +- [Confirmation](interfaces/Confirmation.md) +- [ConfirmationDialog](interfaces/ConfirmationDialog.md) +- [ContextBlock](interfaces/ContextBlock.md) +- [ConversationsApproveSharedInviteArguments](interfaces/ConversationsApproveSharedInviteArguments.md) +- [ConversationsArchiveArguments](interfaces/ConversationsArchiveArguments.md) +- [ConversationsCanvasesCreateArguments](interfaces/ConversationsCanvasesCreateArguments.md) +- [ConversationsCloseArguments](interfaces/ConversationsCloseArguments.md) +- [ConversationsCreateArguments](interfaces/ConversationsCreateArguments.md) +- [ConversationsDeclineSharedInviteArguments](interfaces/ConversationsDeclineSharedInviteArguments.md) +- [ConversationsExternalInvitePermissionsSetArguments](interfaces/ConversationsExternalInvitePermissionsSetArguments.md) +- [ConversationsHistoryArguments](interfaces/ConversationsHistoryArguments.md) +- [ConversationsInfoArguments](interfaces/ConversationsInfoArguments.md) +- [ConversationsInviteArguments](interfaces/ConversationsInviteArguments.md) +- [ConversationsJoinArguments](interfaces/ConversationsJoinArguments.md) +- [ConversationsKickArguments](interfaces/ConversationsKickArguments.md) +- [ConversationsLeaveArguments](interfaces/ConversationsLeaveArguments.md) +- [ConversationsMarkArguments](interfaces/ConversationsMarkArguments.md) +- [ConversationsMembersArguments](interfaces/ConversationsMembersArguments.md) +- [ConversationsRenameArguments](interfaces/ConversationsRenameArguments.md) +- [ConversationsRepliesArguments](interfaces/ConversationsRepliesArguments.md) +- [ConversationsSelect](interfaces/ConversationsSelect.md) +- [ConversationsSetPurposeArguments](interfaces/ConversationsSetPurposeArguments.md) +- [ConversationsSetTopicArguments](interfaces/ConversationsSetTopicArguments.md) +- [ConversationsUnarchiveArguments](interfaces/ConversationsUnarchiveArguments.md) +- [DateTimepicker](interfaces/DateTimepicker.md) +- [Datepicker](interfaces/Datepicker.md) +- [Dialog](interfaces/Dialog.md) +- [DialogOpenArguments](interfaces/DialogOpenArguments.md) +- [DispatchActionConfig](interfaces/DispatchActionConfig.md) +- [Dispatchable](interfaces/Dispatchable.md) +- [DividerBlock](interfaces/DividerBlock.md) +- [DndSetSnoozeArguments](interfaces/DndSetSnoozeArguments.md) +- [DndTeamInfoArguments](interfaces/DndTeamInfoArguments.md) +- [EmailInput](interfaces/EmailInput.md) +- [ExternalSelect](interfaces/ExternalSelect.md) +- [FileBlock](interfaces/FileBlock.md) +- [FileInput](interfaces/FileInput.md) +- [FilesCommentsDeleteArguments](interfaces/FilesCommentsDeleteArguments.md) +- [FilesDeleteArguments](interfaces/FilesDeleteArguments.md) +- [FilesGetUploadURLExternalArguments](interfaces/FilesGetUploadURLExternalArguments.md) +- [FilesInfoArguments](interfaces/FilesInfoArguments.md) +- [FilesListArguments](interfaces/FilesListArguments.md) +- [FilesRemoteAddArguments](interfaces/FilesRemoteAddArguments.md) +- [FilesRemoteListArguments](interfaces/FilesRemoteListArguments.md) +- [FilesRevokePublicURLArguments](interfaces/FilesRevokePublicURLArguments.md) +- [FilesSharedPublicURLArguments](interfaces/FilesSharedPublicURLArguments.md) +- [Focusable](interfaces/Focusable.md) +- [FunctionsCompleteErrorArguments](interfaces/FunctionsCompleteErrorArguments.md) +- [FunctionsCompleteSuccessArguments](interfaces/FunctionsCompleteSuccessArguments.md) +- [HeaderBlock](interfaces/HeaderBlock.md) +- [HomeView](interfaces/HomeView.md) +- [InputBlock](interfaces/InputBlock.md) +- [LinkUnfurls](interfaces/LinkUnfurls.md) +- [Logger](interfaces/Logger.md) +- [MessageAttachment](interfaces/MessageAttachment.md) +- [MessageAttachmentField](interfaces/MessageAttachmentField.md) +- [MessageAttachmentPreview](interfaces/MessageAttachmentPreview.md) +- [MessageMetadata](interfaces/MessageMetadata.md) +- [MessageMetadataEventPayloadObject](interfaces/MessageMetadataEventPayloadObject.md) +- [Method](interfaces/Method.md) +- [MigrationExchangeArguments](interfaces/MigrationExchangeArguments.md) +- [ModalView](interfaces/ModalView.md) +- [MrkdwnElement](interfaces/MrkdwnElement.md) +- [MrkdwnOption](interfaces/MrkdwnOption.md) +- [MultiChannelsSelect](interfaces/MultiChannelsSelect.md) +- [MultiConversationsSelect](interfaces/MultiConversationsSelect.md) +- [MultiExternalSelect](interfaces/MultiExternalSelect.md) +- [MultiStaticSelect](interfaces/MultiStaticSelect.md) +- [MultiUsersSelect](interfaces/MultiUsersSelect.md) +- [NumberInput](interfaces/NumberInput.md) +- [OAuthAccessArguments](interfaces/OAuthAccessArguments.md) +- [OAuthV2AccessArguments](interfaces/OAuthV2AccessArguments.md) +- [OAuthV2ExchangeArguments](interfaces/OAuthV2ExchangeArguments.md) +- [OpenIDConnectTokenArguments](interfaces/OpenIDConnectTokenArguments.md) +- [OptionField](interfaces/OptionField.md) +- [OptionGroup](interfaces/OptionGroup.md) +- [Overflow](interfaces/Overflow.md) +- [PageReducer](interfaces/PageReducer.md) +- [PaginatePredicate](interfaces/PaginatePredicate.md) +- [PinsAddArguments](interfaces/PinsAddArguments.md) +- [PinsListArguments](interfaces/PinsListArguments.md) +- [PinsRemoveArguments](interfaces/PinsRemoveArguments.md) +- [Placeholdable](interfaces/Placeholdable.md) +- [PlainTextElement](interfaces/PlainTextElement.md) +- [PlainTextInput](interfaces/PlainTextInput.md) +- [PlainTextOption](interfaces/PlainTextOption.md) +- [RadioButtons](interfaces/RadioButtons.md) +- [ReactionsAddArguments](interfaces/ReactionsAddArguments.md) +- [RemindersAddArguments](interfaces/RemindersAddArguments.md) +- [RemindersCompleteArguments](interfaces/RemindersCompleteArguments.md) +- [RemindersDeleteArguments](interfaces/RemindersDeleteArguments.md) +- [RemindersInfoArguments](interfaces/RemindersInfoArguments.md) +- [RetryOptions](interfaces/RetryOptions.md) +- [RichTextBlock](interfaces/RichTextBlock.md) +- [RichTextBroadcastMention](interfaces/RichTextBroadcastMention.md) +- [RichTextChannelMention](interfaces/RichTextChannelMention.md) +- [RichTextColor](interfaces/RichTextColor.md) +- [RichTextDate](interfaces/RichTextDate.md) +- [RichTextEmoji](interfaces/RichTextEmoji.md) +- [RichTextInput](interfaces/RichTextInput.md) +- [RichTextLink](interfaces/RichTextLink.md) +- [RichTextList](interfaces/RichTextList.md) +- [RichTextPreformatted](interfaces/RichTextPreformatted.md) +- [RichTextQuote](interfaces/RichTextQuote.md) +- [RichTextSection](interfaces/RichTextSection.md) +- [RichTextStyleable](interfaces/RichTextStyleable.md) +- [RichTextTeamMention](interfaces/RichTextTeamMention.md) +- [RichTextText](interfaces/RichTextText.md) +- [RichTextUserMention](interfaces/RichTextUserMention.md) +- [RichTextUsergroupMention](interfaces/RichTextUsergroupMention.md) +- [SearchAllArguments](interfaces/SearchAllArguments.md) +- [SearchFilesArguments](interfaces/SearchFilesArguments.md) +- [SearchMessagesArguments](interfaces/SearchMessagesArguments.md) +- [SectionBlock](interfaces/SectionBlock.md) +- [SelectOption](interfaces/SelectOption.md) +- [SlackFileImageObject](interfaces/SlackFileImageObject.md) +- [StarsListArguments](interfaces/StarsListArguments.md) +- [StaticSelect](interfaces/StaticSelect.md) +- [Timepicker](interfaces/Timepicker.md) +- [ToolingTokensRotateArguments](interfaces/ToolingTokensRotateArguments.md) +- [URLInput](interfaces/URLInput.md) +- [UrlImageObject](interfaces/UrlImageObject.md) +- [UsergroupsCreateArguments](interfaces/UsergroupsCreateArguments.md) +- [UsergroupsDisableArguments](interfaces/UsergroupsDisableArguments.md) +- [UsergroupsEnableArguments](interfaces/UsergroupsEnableArguments.md) +- [UsergroupsUpdateArguments](interfaces/UsergroupsUpdateArguments.md) +- [UsergroupsUsersListArguments](interfaces/UsergroupsUsersListArguments.md) +- [UsergroupsUsersUpdateArguments](interfaces/UsergroupsUsersUpdateArguments.md) +- [UsersConversationsArguments](interfaces/UsersConversationsArguments.md) +- [UsersDeletePhotoArguments](interfaces/UsersDeletePhotoArguments.md) +- [UsersDiscoverableContactsLookupArguments](interfaces/UsersDiscoverableContactsLookupArguments.md) +- [UsersGetPresenceArguments](interfaces/UsersGetPresenceArguments.md) +- [UsersIdentityArguments](interfaces/UsersIdentityArguments.md) +- [UsersInfoArguments](interfaces/UsersInfoArguments.md) +- [UsersListArguments](interfaces/UsersListArguments.md) +- [UsersLookupByEmailArguments](interfaces/UsersLookupByEmailArguments.md) +- [UsersProfileGetArguments](interfaces/UsersProfileGetArguments.md) +- [UsersProfileSetArguments](interfaces/UsersProfileSetArguments.md) +- [UsersSelect](interfaces/UsersSelect.md) +- [UsersSetPhotoArguments](interfaces/UsersSetPhotoArguments.md) +- [UsersSetPresenceArguments](interfaces/UsersSetPresenceArguments.md) +- [VideoBlock](interfaces/VideoBlock.md) +- [ViewsPublishArguments](interfaces/ViewsPublishArguments.md) +- [WebAPICallResult](interfaces/WebAPICallResult.md) +- [WebAPIHTTPError](interfaces/WebAPIHTTPError.md) +- [WebAPIPlatformError](interfaces/WebAPIPlatformError.md) +- [WebAPIRateLimitedError](interfaces/WebAPIRateLimitedError.md) +- [WebAPIRequestError](interfaces/WebAPIRequestError.md) +- [WebClientOptions](interfaces/WebClientOptions.md) +- [WorkflowButton](interfaces/WorkflowButton.md) +- [WorkflowStepView](interfaces/WorkflowStepView.md) +- [WorkflowsStepCompletedArguments](interfaces/WorkflowsStepCompletedArguments.md) +- [WorkflowsStepFailedArguments](interfaces/WorkflowsStepFailedArguments.md) +- [WorkflowsUpdateStepArguments](interfaces/WorkflowsUpdateStepArguments.md) + +## Type Aliases + +- [APITestArguments](type-aliases/APITestArguments.md) +- [AdminAnalyticsGetFileArguments](type-aliases/AdminAnalyticsGetFileArguments.md) +- [AdminAnalyticsGetFileResponse](type-aliases/AdminAnalyticsGetFileResponse.md) +- [AdminAppsActivitiesListArguments](type-aliases/AdminAppsActivitiesListArguments.md) +- [AdminAppsActivitiesListResponse](type-aliases/AdminAppsActivitiesListResponse.md) +- [AdminAppsApproveArguments](type-aliases/AdminAppsApproveArguments.md) +- [AdminAppsApproveResponse](type-aliases/AdminAppsApproveResponse.md) +- [AdminAppsApprovedListArguments](type-aliases/AdminAppsApprovedListArguments.md) +- [AdminAppsApprovedListResponse](type-aliases/AdminAppsApprovedListResponse.md) +- [AdminAppsClearResolutionArguments](type-aliases/AdminAppsClearResolutionArguments.md) +- [AdminAppsClearResolutionResponse](type-aliases/AdminAppsClearResolutionResponse.md) +- [AdminAppsConfigLookupResponse](type-aliases/AdminAppsConfigLookupResponse.md) +- [AdminAppsConfigSetResponse](type-aliases/AdminAppsConfigSetResponse.md) +- [AdminAppsRequestsCancelArguments](type-aliases/AdminAppsRequestsCancelArguments.md) +- [AdminAppsRequestsCancelResponse](type-aliases/AdminAppsRequestsCancelResponse.md) +- [AdminAppsRequestsListArguments](type-aliases/AdminAppsRequestsListArguments.md) +- [AdminAppsRequestsListResponse](type-aliases/AdminAppsRequestsListResponse.md) +- [AdminAppsRestrictArguments](type-aliases/AdminAppsRestrictArguments.md) +- [AdminAppsRestrictResponse](type-aliases/AdminAppsRestrictResponse.md) +- [AdminAppsRestrictedListArguments](type-aliases/AdminAppsRestrictedListArguments.md) +- [AdminAppsRestrictedListResponse](type-aliases/AdminAppsRestrictedListResponse.md) +- [AdminAppsUninstallArguments](type-aliases/AdminAppsUninstallArguments.md) +- [AdminAppsUninstallResponse](type-aliases/AdminAppsUninstallResponse.md) +- [AdminAuthPolicyAssignEntitiesResponse](type-aliases/AdminAuthPolicyAssignEntitiesResponse.md) +- [AdminAuthPolicyGetEntitiesResponse](type-aliases/AdminAuthPolicyGetEntitiesResponse.md) +- [AdminAuthPolicyRemoveEntitiesResponse](type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md) +- [AdminBarriersCreateResponse](type-aliases/AdminBarriersCreateResponse.md) +- [AdminBarriersDeleteResponse](type-aliases/AdminBarriersDeleteResponse.md) +- [AdminBarriersListArguments](type-aliases/AdminBarriersListArguments.md) +- [AdminBarriersListResponse](type-aliases/AdminBarriersListResponse.md) +- [AdminBarriersUpdateResponse](type-aliases/AdminBarriersUpdateResponse.md) +- [AdminConversationsArchiveResponse](type-aliases/AdminConversationsArchiveResponse.md) +- [AdminConversationsBulkArchiveResponse](type-aliases/AdminConversationsBulkArchiveResponse.md) +- [AdminConversationsBulkDeleteResponse](type-aliases/AdminConversationsBulkDeleteResponse.md) +- [AdminConversationsBulkMoveResponse](type-aliases/AdminConversationsBulkMoveResponse.md) +- [AdminConversationsConvertToPrivateResponse](type-aliases/AdminConversationsConvertToPrivateResponse.md) +- [AdminConversationsConvertToPublicResponse](type-aliases/AdminConversationsConvertToPublicResponse.md) +- [AdminConversationsCreateArguments](type-aliases/AdminConversationsCreateArguments.md) +- [AdminConversationsCreateResponse](type-aliases/AdminConversationsCreateResponse.md) +- [AdminConversationsDeleteResponse](type-aliases/AdminConversationsDeleteResponse.md) +- [AdminConversationsDisconnectSharedResponse](type-aliases/AdminConversationsDisconnectSharedResponse.md) +- [AdminConversationsEKMListOriginalConnectedChannelInfoArguments](type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md) +- [AdminConversationsEkmListOriginalConnectedChannelInfoResponse](type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md) +- [AdminConversationsGetConversationPrefsResponse](type-aliases/AdminConversationsGetConversationPrefsResponse.md) +- [AdminConversationsGetCustomRetentionResponse](type-aliases/AdminConversationsGetCustomRetentionResponse.md) +- [AdminConversationsGetTeamsResponse](type-aliases/AdminConversationsGetTeamsResponse.md) +- [AdminConversationsInviteResponse](type-aliases/AdminConversationsInviteResponse.md) +- [AdminConversationsLookupResponse](type-aliases/AdminConversationsLookupResponse.md) +- [AdminConversationsRemoveCustomRetentionResponse](type-aliases/AdminConversationsRemoveCustomRetentionResponse.md) +- [AdminConversationsRenameResponse](type-aliases/AdminConversationsRenameResponse.md) +- [AdminConversationsRestrictAccessAddGroupResponse](type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md) +- [AdminConversationsRestrictAccessListGroupsResponse](type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md) +- [AdminConversationsRestrictAccessRemoveGroupResponse](type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md) +- [AdminConversationsSearchArguments](type-aliases/AdminConversationsSearchArguments.md) +- [AdminConversationsSearchResponse](type-aliases/AdminConversationsSearchResponse.md) +- [AdminConversationsSetConversationPrefsResponse](type-aliases/AdminConversationsSetConversationPrefsResponse.md) +- [AdminConversationsSetCustomRetentionResponse](type-aliases/AdminConversationsSetCustomRetentionResponse.md) +- [AdminConversationsSetTeamsResponse](type-aliases/AdminConversationsSetTeamsResponse.md) +- [AdminConversationsUnarchiveResponse](type-aliases/AdminConversationsUnarchiveResponse.md) +- [AdminConversationsWhitelistAddResponse](type-aliases/AdminConversationsWhitelistAddResponse.md) +- [AdminConversationsWhitelistListGroupsLinkedToChannelResponse](type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md) +- [AdminConversationsWhitelistRemoveResponse](type-aliases/AdminConversationsWhitelistRemoveResponse.md) +- [AdminEmojiAddAliasResponse](type-aliases/AdminEmojiAddAliasResponse.md) +- [AdminEmojiAddResponse](type-aliases/AdminEmojiAddResponse.md) +- [AdminEmojiListArguments](type-aliases/AdminEmojiListArguments.md) +- [AdminEmojiListResponse](type-aliases/AdminEmojiListResponse.md) +- [AdminEmojiRemoveResponse](type-aliases/AdminEmojiRemoveResponse.md) +- [AdminEmojiRenameResponse](type-aliases/AdminEmojiRenameResponse.md) +- [AdminFunctionsListResponse](type-aliases/AdminFunctionsListResponse.md) +- [AdminFunctionsPermissionsLookupResponse](type-aliases/AdminFunctionsPermissionsLookupResponse.md) +- [AdminFunctionsPermissionsSetResponse](type-aliases/AdminFunctionsPermissionsSetResponse.md) +- [AdminInviteRequestsApproveResponse](type-aliases/AdminInviteRequestsApproveResponse.md) +- [AdminInviteRequestsApprovedListResponse](type-aliases/AdminInviteRequestsApprovedListResponse.md) +- [AdminInviteRequestsDeniedListResponse](type-aliases/AdminInviteRequestsDeniedListResponse.md) +- [AdminInviteRequestsDenyResponse](type-aliases/AdminInviteRequestsDenyResponse.md) +- [AdminInviteRequestsListResponse](type-aliases/AdminInviteRequestsListResponse.md) +- [AdminRolesAddAssignmentsResponse](type-aliases/AdminRolesAddAssignmentsResponse.md) +- [AdminRolesListAssignmentsArguments](type-aliases/AdminRolesListAssignmentsArguments.md) +- [AdminRolesListAssignmentsResponse](type-aliases/AdminRolesListAssignmentsResponse.md) +- [AdminRolesRemoveAssignmentsResponse](type-aliases/AdminRolesRemoveAssignmentsResponse.md) +- [AdminTeamsAdminsListResponse](type-aliases/AdminTeamsAdminsListResponse.md) +- [AdminTeamsCreateResponse](type-aliases/AdminTeamsCreateResponse.md) +- [AdminTeamsListArguments](type-aliases/AdminTeamsListArguments.md) +- [AdminTeamsListResponse](type-aliases/AdminTeamsListResponse.md) +- [AdminTeamsOwnersListResponse](type-aliases/AdminTeamsOwnersListResponse.md) +- [AdminTeamsSettingsInfoResponse](type-aliases/AdminTeamsSettingsInfoResponse.md) +- [AdminTeamsSettingsSetDefaultChannelsResponse](type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md) +- [AdminTeamsSettingsSetDescriptionResponse](type-aliases/AdminTeamsSettingsSetDescriptionResponse.md) +- [AdminTeamsSettingsSetDiscoverabilityResponse](type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md) +- [AdminTeamsSettingsSetIconResponse](type-aliases/AdminTeamsSettingsSetIconResponse.md) +- [AdminTeamsSettingsSetNameResponse](type-aliases/AdminTeamsSettingsSetNameResponse.md) +- [AdminUsergroupsAddChannelsResponse](type-aliases/AdminUsergroupsAddChannelsResponse.md) +- [AdminUsergroupsAddTeamsResponse](type-aliases/AdminUsergroupsAddTeamsResponse.md) +- [AdminUsergroupsListChannelsResponse](type-aliases/AdminUsergroupsListChannelsResponse.md) +- [AdminUsergroupsRemoveChannelsResponse](type-aliases/AdminUsergroupsRemoveChannelsResponse.md) +- [AdminUsersAssignResponse](type-aliases/AdminUsersAssignResponse.md) +- [AdminUsersInviteResponse](type-aliases/AdminUsersInviteResponse.md) +- [AdminUsersListArguments](type-aliases/AdminUsersListArguments.md) +- [AdminUsersListResponse](type-aliases/AdminUsersListResponse.md) +- [AdminUsersRemoveResponse](type-aliases/AdminUsersRemoveResponse.md) +- [AdminUsersSessionClearSettingsResponse](type-aliases/AdminUsersSessionClearSettingsResponse.md) +- [AdminUsersSessionGetSettingsResponse](type-aliases/AdminUsersSessionGetSettingsResponse.md) +- [AdminUsersSessionInvalidateResponse](type-aliases/AdminUsersSessionInvalidateResponse.md) +- [AdminUsersSessionListArguments](type-aliases/AdminUsersSessionListArguments.md) +- [AdminUsersSessionListResponse](type-aliases/AdminUsersSessionListResponse.md) +- [AdminUsersSessionResetBulkResponse](type-aliases/AdminUsersSessionResetBulkResponse.md) +- [AdminUsersSessionResetResponse](type-aliases/AdminUsersSessionResetResponse.md) +- [AdminUsersSessionSetSettingsResponse](type-aliases/AdminUsersSessionSetSettingsResponse.md) +- [AdminUsersSetAdminResponse](type-aliases/AdminUsersSetAdminResponse.md) +- [AdminUsersSetExpirationResponse](type-aliases/AdminUsersSetExpirationResponse.md) +- [AdminUsersSetOwnerResponse](type-aliases/AdminUsersSetOwnerResponse.md) +- [AdminUsersSetRegularResponse](type-aliases/AdminUsersSetRegularResponse.md) +- [AdminUsersUnsupportedVersionsExportResponse](type-aliases/AdminUsersUnsupportedVersionsExportResponse.md) +- [AdminWorkflowsCollaboratorsAddResponse](type-aliases/AdminWorkflowsCollaboratorsAddResponse.md) +- [AdminWorkflowsCollaboratorsRemoveResponse](type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md) +- [AdminWorkflowsPermissionsLookupResponse](type-aliases/AdminWorkflowsPermissionsLookupResponse.md) +- [AdminWorkflowsSearchArguments](type-aliases/AdminWorkflowsSearchArguments.md) +- [AdminWorkflowsSearchResponse](type-aliases/AdminWorkflowsSearchResponse.md) +- [AdminWorkflowsUnpublishResponse](type-aliases/AdminWorkflowsUnpublishResponse.md) +- [ApiTestResponse](type-aliases/ApiTestResponse.md) +- [AppsConnectionsOpenArguments](type-aliases/AppsConnectionsOpenArguments.md) +- [AppsConnectionsOpenResponse](type-aliases/AppsConnectionsOpenResponse.md) +- [AppsEventAuthorizationsListResponse](type-aliases/AppsEventAuthorizationsListResponse.md) +- [AppsManifestCreateResponse](type-aliases/AppsManifestCreateResponse.md) +- [AppsManifestDeleteResponse](type-aliases/AppsManifestDeleteResponse.md) +- [AppsManifestExportResponse](type-aliases/AppsManifestExportResponse.md) +- [AppsManifestUpdateResponse](type-aliases/AppsManifestUpdateResponse.md) +- [AppsManifestValidateResponse](type-aliases/AppsManifestValidateResponse.md) +- [AppsPermissionsInfoResponse](type-aliases/AppsPermissionsInfoResponse.md) +- [AppsPermissionsRequestResponse](type-aliases/AppsPermissionsRequestResponse.md) +- [AppsPermissionsResourcesListResponse](type-aliases/AppsPermissionsResourcesListResponse.md) +- [AppsPermissionsScopesListResponse](type-aliases/AppsPermissionsScopesListResponse.md) +- [AppsPermissionsUsersListResponse](type-aliases/AppsPermissionsUsersListResponse.md) +- [AppsPermissionsUsersRequestResponse](type-aliases/AppsPermissionsUsersRequestResponse.md) +- [AppsUninstallResponse](type-aliases/AppsUninstallResponse.md) +- [AuthRevokeArguments](type-aliases/AuthRevokeArguments.md) +- [AuthRevokeResponse](type-aliases/AuthRevokeResponse.md) +- [AuthTeamsListArguments](type-aliases/AuthTeamsListArguments.md) +- [AuthTeamsListResponse](type-aliases/AuthTeamsListResponse.md) +- [AuthTestArguments](type-aliases/AuthTestArguments.md) +- [AuthTestResponse](type-aliases/AuthTestResponse.md) +- [BookmarksAddResponse](type-aliases/BookmarksAddResponse.md) +- [BookmarksEditResponse](type-aliases/BookmarksEditResponse.md) +- [BookmarksListResponse](type-aliases/BookmarksListResponse.md) +- [BookmarksRemoveResponse](type-aliases/BookmarksRemoveResponse.md) +- [BotsInfoArguments](type-aliases/BotsInfoArguments.md) +- [BotsInfoResponse](type-aliases/BotsInfoResponse.md) +- [CallUser](type-aliases/CallUser.md) +- [CallsAddResponse](type-aliases/CallsAddResponse.md) +- [CallsEndResponse](type-aliases/CallsEndResponse.md) +- [CallsInfoResponse](type-aliases/CallsInfoResponse.md) +- [CallsParticipantsAddResponse](type-aliases/CallsParticipantsAddResponse.md) +- [CallsParticipantsRemoveResponse](type-aliases/CallsParticipantsRemoveResponse.md) +- [CallsUpdateResponse](type-aliases/CallsUpdateResponse.md) +- [CanvasesAccessDeleteResponse](type-aliases/CanvasesAccessDeleteResponse.md) +- [CanvasesAccessSetResponse](type-aliases/CanvasesAccessSetResponse.md) +- [CanvasesCreateArguments](type-aliases/CanvasesCreateArguments.md) +- [CanvasesCreateResponse](type-aliases/CanvasesCreateResponse.md) +- [CanvasesDeleteResponse](type-aliases/CanvasesDeleteResponse.md) +- [CanvasesEditResponse](type-aliases/CanvasesEditResponse.md) +- [CanvasesSectionsLookupResponse](type-aliases/CanvasesSectionsLookupResponse.md) +- [ChannelsArchiveResponse](type-aliases/ChannelsArchiveResponse.md) +- [ChannelsCreateResponse](type-aliases/ChannelsCreateResponse.md) +- [ChannelsHistoryResponse](type-aliases/ChannelsHistoryResponse.md) +- [ChannelsInfoResponse](type-aliases/ChannelsInfoResponse.md) +- [ChannelsInviteResponse](type-aliases/ChannelsInviteResponse.md) +- [ChannelsJoinResponse](type-aliases/ChannelsJoinResponse.md) +- [ChannelsKickResponse](type-aliases/ChannelsKickResponse.md) +- [ChannelsLeaveResponse](type-aliases/ChannelsLeaveResponse.md) +- [ChannelsListResponse](type-aliases/ChannelsListResponse.md) +- [ChannelsMarkResponse](type-aliases/ChannelsMarkResponse.md) +- [ChannelsRenameResponse](type-aliases/ChannelsRenameResponse.md) +- [ChannelsRepliesResponse](type-aliases/ChannelsRepliesResponse.md) +- [ChannelsSetPurposeResponse](type-aliases/ChannelsSetPurposeResponse.md) +- [ChannelsSetTopicResponse](type-aliases/ChannelsSetTopicResponse.md) +- [ChannelsUnarchiveResponse](type-aliases/ChannelsUnarchiveResponse.md) +- [ChatDeleteResponse](type-aliases/ChatDeleteResponse.md) +- [ChatDeleteScheduledMessageResponse](type-aliases/ChatDeleteScheduledMessageResponse.md) +- [ChatGetPermalinkResponse](type-aliases/ChatGetPermalinkResponse.md) +- [ChatMeMessageResponse](type-aliases/ChatMeMessageResponse.md) +- [ChatPostEphemeralArguments](type-aliases/ChatPostEphemeralArguments.md) +- [ChatPostEphemeralResponse](type-aliases/ChatPostEphemeralResponse.md) +- [ChatPostMessageArguments](type-aliases/ChatPostMessageArguments.md) +- [ChatPostMessageResponse](type-aliases/ChatPostMessageResponse.md) +- [ChatScheduleMessageArguments](type-aliases/ChatScheduleMessageArguments.md) +- [ChatScheduleMessageResponse](type-aliases/ChatScheduleMessageResponse.md) +- [ChatScheduledMessagesListArguments](type-aliases/ChatScheduledMessagesListArguments.md) +- [ChatScheduledMessagesListResponse](type-aliases/ChatScheduledMessagesListResponse.md) +- [ChatUnfurlArguments](type-aliases/ChatUnfurlArguments.md) +- [ChatUnfurlResponse](type-aliases/ChatUnfurlResponse.md) +- [ChatUpdateArguments](type-aliases/ChatUpdateArguments.md) +- [ChatUpdateResponse](type-aliases/ChatUpdateResponse.md) +- [ConversationFilter](type-aliases/ConversationFilter.md) +- [ConversationsAcceptSharedInviteArguments](type-aliases/ConversationsAcceptSharedInviteArguments.md) +- [ConversationsAcceptSharedInviteResponse](type-aliases/ConversationsAcceptSharedInviteResponse.md) +- [ConversationsApproveSharedInviteResponse](type-aliases/ConversationsApproveSharedInviteResponse.md) +- [ConversationsArchiveResponse](type-aliases/ConversationsArchiveResponse.md) +- [ConversationsCanvasesCreateResponse](type-aliases/ConversationsCanvasesCreateResponse.md) +- [ConversationsCloseResponse](type-aliases/ConversationsCloseResponse.md) +- [ConversationsCreateResponse](type-aliases/ConversationsCreateResponse.md) +- [ConversationsDeclineSharedInviteResponse](type-aliases/ConversationsDeclineSharedInviteResponse.md) +- [ConversationsExternalInvitePermissionsSetResponse](type-aliases/ConversationsExternalInvitePermissionsSetResponse.md) +- [ConversationsHistoryResponse](type-aliases/ConversationsHistoryResponse.md) +- [ConversationsInfoResponse](type-aliases/ConversationsInfoResponse.md) +- [ConversationsInviteResponse](type-aliases/ConversationsInviteResponse.md) +- [ConversationsInviteSharedArguments](type-aliases/ConversationsInviteSharedArguments.md) +- [ConversationsInviteSharedResponse](type-aliases/ConversationsInviteSharedResponse.md) +- [ConversationsJoinResponse](type-aliases/ConversationsJoinResponse.md) +- [ConversationsKickResponse](type-aliases/ConversationsKickResponse.md) +- [ConversationsLeaveResponse](type-aliases/ConversationsLeaveResponse.md) +- [ConversationsListArguments](type-aliases/ConversationsListArguments.md) +- [ConversationsListConnectInvitesArguments](type-aliases/ConversationsListConnectInvitesArguments.md) +- [ConversationsListConnectInvitesResponse](type-aliases/ConversationsListConnectInvitesResponse.md) +- [ConversationsListResponse](type-aliases/ConversationsListResponse.md) +- [ConversationsMarkResponse](type-aliases/ConversationsMarkResponse.md) +- [ConversationsMembersResponse](type-aliases/ConversationsMembersResponse.md) +- [ConversationsOpenArguments](type-aliases/ConversationsOpenArguments.md) +- [ConversationsOpenResponse](type-aliases/ConversationsOpenResponse.md) +- [ConversationsRenameResponse](type-aliases/ConversationsRenameResponse.md) +- [ConversationsRepliesResponse](type-aliases/ConversationsRepliesResponse.md) +- [ConversationsSetPurposeResponse](type-aliases/ConversationsSetPurposeResponse.md) +- [ConversationsSetTopicResponse](type-aliases/ConversationsSetTopicResponse.md) +- [ConversationsUnarchiveResponse](type-aliases/ConversationsUnarchiveResponse.md) +- [DialogOpenResponse](type-aliases/DialogOpenResponse.md) +- [DndEndDndArguments](type-aliases/DndEndDndArguments.md) +- [DndEndDndResponse](type-aliases/DndEndDndResponse.md) +- [DndEndSnoozeArguments](type-aliases/DndEndSnoozeArguments.md) +- [DndEndSnoozeResponse](type-aliases/DndEndSnoozeResponse.md) +- [DndInfoArguments](type-aliases/DndInfoArguments.md) +- [DndInfoResponse](type-aliases/DndInfoResponse.md) +- [DndSetSnoozeResponse](type-aliases/DndSetSnoozeResponse.md) +- [DndTeamInfoResponse](type-aliases/DndTeamInfoResponse.md) +- [EmojiListArguments](type-aliases/EmojiListArguments.md) +- [EmojiListResponse](type-aliases/EmojiListResponse.md) +- [FilesCommentsAddResponse](type-aliases/FilesCommentsAddResponse.md) +- [FilesCommentsDeleteResponse](type-aliases/FilesCommentsDeleteResponse.md) +- [FilesCommentsEditResponse](type-aliases/FilesCommentsEditResponse.md) +- [FilesCompleteUploadExternalArguments](type-aliases/FilesCompleteUploadExternalArguments.md) +- [FilesCompleteUploadExternalResponse](type-aliases/FilesCompleteUploadExternalResponse.md) +- [FilesDeleteResponse](type-aliases/FilesDeleteResponse.md) +- [FilesGetUploadURLExternalResponse](type-aliases/FilesGetUploadURLExternalResponse.md) +- [FilesInfoResponse](type-aliases/FilesInfoResponse.md) +- [FilesListResponse](type-aliases/FilesListResponse.md) +- [FilesRemoteAddResponse](type-aliases/FilesRemoteAddResponse.md) +- [FilesRemoteInfoArguments](type-aliases/FilesRemoteInfoArguments.md) +- [FilesRemoteInfoResponse](type-aliases/FilesRemoteInfoResponse.md) +- [FilesRemoteListResponse](type-aliases/FilesRemoteListResponse.md) +- [FilesRemoteRemoveArguments](type-aliases/FilesRemoteRemoveArguments.md) +- [FilesRemoteRemoveResponse](type-aliases/FilesRemoteRemoveResponse.md) +- [FilesRemoteShareArguments](type-aliases/FilesRemoteShareArguments.md) +- [FilesRemoteShareResponse](type-aliases/FilesRemoteShareResponse.md) +- [FilesRemoteUpdateArguments](type-aliases/FilesRemoteUpdateArguments.md) +- [FilesRemoteUpdateResponse](type-aliases/FilesRemoteUpdateResponse.md) +- [FilesRevokePublicURLResponse](type-aliases/FilesRevokePublicURLResponse.md) +- [FilesSharedPublicURLResponse](type-aliases/FilesSharedPublicURLResponse.md) +- [FilesUploadArguments](type-aliases/FilesUploadArguments.md) +- [FilesUploadResponse](type-aliases/FilesUploadResponse.md) +- [FilesUploadV2Arguments](type-aliases/FilesUploadV2Arguments.md) +- [FunctionsCompleteErrorResponse](type-aliases/FunctionsCompleteErrorResponse.md) +- [FunctionsCompleteSuccessResponse](type-aliases/FunctionsCompleteSuccessResponse.md) +- [GroupsArchiveResponse](type-aliases/GroupsArchiveResponse.md) +- [GroupsCloseResponse](type-aliases/GroupsCloseResponse.md) +- [GroupsCreateChildResponse](type-aliases/GroupsCreateChildResponse.md) +- [GroupsCreateResponse](type-aliases/GroupsCreateResponse.md) +- [GroupsHistoryResponse](type-aliases/GroupsHistoryResponse.md) +- [GroupsInfoResponse](type-aliases/GroupsInfoResponse.md) +- [GroupsInviteResponse](type-aliases/GroupsInviteResponse.md) +- [GroupsKickResponse](type-aliases/GroupsKickResponse.md) +- [GroupsLeaveResponse](type-aliases/GroupsLeaveResponse.md) +- [GroupsListResponse](type-aliases/GroupsListResponse.md) +- [GroupsMarkResponse](type-aliases/GroupsMarkResponse.md) +- [GroupsOpenResponse](type-aliases/GroupsOpenResponse.md) +- [GroupsRenameResponse](type-aliases/GroupsRenameResponse.md) +- [GroupsRepliesResponse](type-aliases/GroupsRepliesResponse.md) +- [GroupsSetPurposeResponse](type-aliases/GroupsSetPurposeResponse.md) +- [GroupsSetTopicResponse](type-aliases/GroupsSetTopicResponse.md) +- [GroupsUnarchiveResponse](type-aliases/GroupsUnarchiveResponse.md) +- [ImCloseResponse](type-aliases/ImCloseResponse.md) +- [ImHistoryResponse](type-aliases/ImHistoryResponse.md) +- [ImListResponse](type-aliases/ImListResponse.md) +- [ImMarkResponse](type-aliases/ImMarkResponse.md) +- [ImOpenResponse](type-aliases/ImOpenResponse.md) +- [ImRepliesResponse](type-aliases/ImRepliesResponse.md) +- [ImageBlock](type-aliases/ImageBlock.md) +- [ImageElement](type-aliases/ImageElement.md) +- [KnownBlock](type-aliases/KnownBlock.md) +- [MigrationExchangeResponse](type-aliases/MigrationExchangeResponse.md) +- [MpimCloseResponse](type-aliases/MpimCloseResponse.md) +- [MpimHistoryResponse](type-aliases/MpimHistoryResponse.md) +- [MpimListResponse](type-aliases/MpimListResponse.md) +- [MpimMarkResponse](type-aliases/MpimMarkResponse.md) +- [MpimOpenResponse](type-aliases/MpimOpenResponse.md) +- [MpimRepliesResponse](type-aliases/MpimRepliesResponse.md) +- [MultiSelect](type-aliases/MultiSelect.md) +- [OauthAccessResponse](type-aliases/OauthAccessResponse.md) +- [OauthTokenResponse](type-aliases/OauthTokenResponse.md) +- [OauthV2AccessResponse](type-aliases/OauthV2AccessResponse.md) +- [OauthV2ExchangeResponse](type-aliases/OauthV2ExchangeResponse.md) +- [OpenIDConnectTokenResponse](type-aliases/OpenIDConnectTokenResponse.md) +- [OpenIDConnectUserInfoArguments](type-aliases/OpenIDConnectUserInfoArguments.md) +- [OpenIDConnectUserInfoResponse](type-aliases/OpenIDConnectUserInfoResponse.md) +- [Option](type-aliases/Option.md) +- [PageAccumulator](type-aliases/PageAccumulator.md) +- [PinsAddResponse](type-aliases/PinsAddResponse.md) +- [PinsListResponse](type-aliases/PinsListResponse.md) +- [PinsRemoveResponse](type-aliases/PinsRemoveResponse.md) +- [RTMConnectArguments](type-aliases/RTMConnectArguments.md) +- [RTMStartArguments](type-aliases/RTMStartArguments.md) +- [ReactionsAddResponse](type-aliases/ReactionsAddResponse.md) +- [ReactionsGetArguments](type-aliases/ReactionsGetArguments.md) +- [ReactionsGetResponse](type-aliases/ReactionsGetResponse.md) +- [ReactionsListArguments](type-aliases/ReactionsListArguments.md) +- [ReactionsListResponse](type-aliases/ReactionsListResponse.md) +- [ReactionsRemoveArguments](type-aliases/ReactionsRemoveArguments.md) +- [ReactionsRemoveResponse](type-aliases/ReactionsRemoveResponse.md) +- [RemindersAddResponse](type-aliases/RemindersAddResponse.md) +- [RemindersCompleteResponse](type-aliases/RemindersCompleteResponse.md) +- [RemindersDeleteResponse](type-aliases/RemindersDeleteResponse.md) +- [RemindersInfoResponse](type-aliases/RemindersInfoResponse.md) +- [RemindersListArguments](type-aliases/RemindersListArguments.md) +- [RemindersListResponse](type-aliases/RemindersListResponse.md) +- [RichTextElement](type-aliases/RichTextElement.md) +- [RtmConnectResponse](type-aliases/RtmConnectResponse.md) +- [RtmStartResponse](type-aliases/RtmStartResponse.md) +- [SearchAllResponse](type-aliases/SearchAllResponse.md) +- [SearchFilesResponse](type-aliases/SearchFilesResponse.md) +- [SearchMessagesResponse](type-aliases/SearchMessagesResponse.md) +- [Select](type-aliases/Select.md) +- [SlackFile](type-aliases/SlackFile.md) +- [StarsAddRemoveArguments](type-aliases/StarsAddRemoveArguments.md) +- [StarsAddResponse](type-aliases/StarsAddResponse.md) +- [StarsListResponse](type-aliases/StarsListResponse.md) +- [StarsRemoveResponse](type-aliases/StarsRemoveResponse.md) +- [TLSOptions](type-aliases/TLSOptions.md) +- [TeamAccessLogsArguments](type-aliases/TeamAccessLogsArguments.md) +- [TeamAccessLogsResponse](type-aliases/TeamAccessLogsResponse.md) +- [TeamBillableInfoArguments](type-aliases/TeamBillableInfoArguments.md) +- [TeamBillableInfoResponse](type-aliases/TeamBillableInfoResponse.md) +- [TeamBillingInfoArguments](type-aliases/TeamBillingInfoArguments.md) +- [TeamBillingInfoResponse](type-aliases/TeamBillingInfoResponse.md) +- [TeamExternalTeamsDisconnectArguments](type-aliases/TeamExternalTeamsDisconnectArguments.md) +- [TeamExternalTeamsDisconnectResponse](type-aliases/TeamExternalTeamsDisconnectResponse.md) +- [TeamExternalTeamsListArguments](type-aliases/TeamExternalTeamsListArguments.md) +- [TeamExternalTeamsListResponse](type-aliases/TeamExternalTeamsListResponse.md) +- [TeamInfoArguments](type-aliases/TeamInfoArguments.md) +- [TeamInfoResponse](type-aliases/TeamInfoResponse.md) +- [TeamIntegrationLogsArguments](type-aliases/TeamIntegrationLogsArguments.md) +- [TeamIntegrationLogsResponse](type-aliases/TeamIntegrationLogsResponse.md) +- [TeamPreferencesListArguments](type-aliases/TeamPreferencesListArguments.md) +- [TeamPreferencesListResponse](type-aliases/TeamPreferencesListResponse.md) +- [TeamProfileGetArguments](type-aliases/TeamProfileGetArguments.md) +- [TeamProfileGetResponse](type-aliases/TeamProfileGetResponse.md) +- [ToolingTokensRotateResponse](type-aliases/ToolingTokensRotateResponse.md) +- [UsergroupsCreateResponse](type-aliases/UsergroupsCreateResponse.md) +- [UsergroupsDisableResponse](type-aliases/UsergroupsDisableResponse.md) +- [UsergroupsEnableResponse](type-aliases/UsergroupsEnableResponse.md) +- [UsergroupsListArguments](type-aliases/UsergroupsListArguments.md) +- [UsergroupsListResponse](type-aliases/UsergroupsListResponse.md) +- [UsergroupsUpdateResponse](type-aliases/UsergroupsUpdateResponse.md) +- [UsergroupsUsersListResponse](type-aliases/UsergroupsUsersListResponse.md) +- [UsergroupsUsersUpdateResponse](type-aliases/UsergroupsUsersUpdateResponse.md) +- [UsersConversationsResponse](type-aliases/UsersConversationsResponse.md) +- [UsersDeletePhotoResponse](type-aliases/UsersDeletePhotoResponse.md) +- [UsersDiscoverableContactsLookupResponse](type-aliases/UsersDiscoverableContactsLookupResponse.md) +- [UsersGetPresenceResponse](type-aliases/UsersGetPresenceResponse.md) +- [UsersIdentityResponse](type-aliases/UsersIdentityResponse.md) +- [UsersInfoResponse](type-aliases/UsersInfoResponse.md) +- [UsersListResponse](type-aliases/UsersListResponse.md) +- [UsersLookupByEmailResponse](type-aliases/UsersLookupByEmailResponse.md) +- [UsersProfileGetResponse](type-aliases/UsersProfileGetResponse.md) +- [UsersProfileSetResponse](type-aliases/UsersProfileSetResponse.md) +- [UsersSetActiveResponse](type-aliases/UsersSetActiveResponse.md) +- [UsersSetPhotoResponse](type-aliases/UsersSetPhotoResponse.md) +- [UsersSetPresenceResponse](type-aliases/UsersSetPresenceResponse.md) +- [View](type-aliases/View.md) +- [ViewsOpenArguments](type-aliases/ViewsOpenArguments.md) +- [ViewsOpenResponse](type-aliases/ViewsOpenResponse.md) +- [ViewsPublishResponse](type-aliases/ViewsPublishResponse.md) +- [ViewsPushArguments](type-aliases/ViewsPushArguments.md) +- [ViewsPushResponse](type-aliases/ViewsPushResponse.md) +- [ViewsUpdateArguments](type-aliases/ViewsUpdateArguments.md) +- [ViewsUpdateResponse](type-aliases/ViewsUpdateResponse.md) +- [WebAPICallError](type-aliases/WebAPICallError.md) +- [WorkflowsStepCompletedResponse](type-aliases/WorkflowsStepCompletedResponse.md) +- [WorkflowsStepFailedResponse](type-aliases/WorkflowsStepFailedResponse.md) +- [WorkflowsUpdateStepResponse](type-aliases/WorkflowsUpdateStepResponse.md) + +## Variables + +- [retryPolicies](variables/retryPolicies.md) + +## Functions + +- [addAppMetadata](functions/addAppMetadata.md) diff --git a/docs/content/reference/web-api/interfaces/Action.md b/docs/content/reference/web-api/interfaces/Action.md new file mode 100644 index 000000000..5623edc50 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Action.md @@ -0,0 +1,37 @@ +# Interface: ~~Action~~ + +## Deprecated + +[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. + +## Extended by + +- [`Actionable`](Actionable.md) + +## Properties + +### ~~action\_id?~~ + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### ~~type~~ + +```ts +type: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/Actionable.md b/docs/content/reference/web-api/interfaces/Actionable.md new file mode 100644 index 000000000..0b57e4a67 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Actionable.md @@ -0,0 +1,71 @@ +# Interface: ~~Actionable~~ + +## Deprecated + +[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. + +## Extends + +- [`Action`](Action.md) + +## Extended by + +- [`Button`](Button.md) +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`EmailInput`](EmailInput.md) +- [`FileInput`](FileInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`Overflow`](Overflow.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### ~~action\_id?~~ + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Action`](Action.md).[`action_id`](Action.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### ~~type~~ + +```ts +type: string; +``` + +#### Inherited from + +[`Action`](Action.md).[`type`](Action.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/ActionsBlock.md b/docs/content/reference/web-api/interfaces/ActionsBlock.md new file mode 100644 index 000000000..dc9cb622b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ActionsBlock.md @@ -0,0 +1,85 @@ +# Interface: ActionsBlock + +## Description + +Holds multiple interactive elements. + +## See + +[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### elements + +```ts +elements: ( + | Button + | Checkboxes + | Datepicker + | DateTimepicker + | MultiSelect + | Overflow + | RadioButtons + | Select + | Timepicker + | WorkflowButton + | RichTextInput)[]; +``` + +#### Description + +An array of InteractiveElements objects. +There is a maximum of 25 elements in each action block. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:29 + +*** + +### type + +```ts +type: "actions"; +``` + +#### Description + +The type of block. For an actions block, `type` is always `actions`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:24 diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md new file mode 100644 index 000000000..8e5881fa0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md @@ -0,0 +1,277 @@ +# Interface: AdminAnalyticsMemberDetails + +## Properties + +### channel\_messages\_posted\_count + +```ts +channel_messages_posted_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L31) + +*** + +### date + +```ts +date: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L20) + +*** + +### date\_claimed + +```ts +date_claimed: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L40) + +*** + +### email\_address + +```ts +email_address: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L22) + +*** + +### enterprise\_id + +```ts +enterprise_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L18) + +*** + +### files\_added\_count + +```ts +files_added_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L32) + +*** + +### is\_active + +```ts +is_active: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L25) + +*** + +### is\_active\_android + +```ts +is_active_android: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L27) + +*** + +### is\_active\_apps + +```ts +is_active_apps: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L33) + +*** + +### is\_active\_desktop + +```ts +is_active_desktop: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L28) + +*** + +### is\_active\_ios + +```ts +is_active_ios: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L26) + +*** + +### is\_active\_slack\_connect + +```ts +is_active_slack_connect: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L35) + +*** + +### is\_active\_workflows + +```ts +is_active_workflows: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L34) + +*** + +### is\_billable\_seat + +```ts +is_billable_seat: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L24) + +*** + +### is\_guest + +```ts +is_guest: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L23) + +*** + +### messages\_posted\_count + +```ts +messages_posted_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L30) + +*** + +### reactions\_added\_count + +```ts +reactions_added_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L29) + +*** + +### search\_count + +```ts +search_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L39) + +*** + +### slack\_calls\_count + +```ts +slack_calls_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L37) + +*** + +### slack\_huddles\_count + +```ts +slack_huddles_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L38) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L19) + +*** + +### total\_calls\_count + +```ts +total_calls_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L36) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L21) diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md new file mode 100644 index 000000000..228187212 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md @@ -0,0 +1,229 @@ +# Interface: AdminAnalyticsPublicChannelDetails + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:46](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L46) + +*** + +### channel\_type + +```ts +channel_type: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L58) + +*** + +### date + +```ts +date: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L62) + +*** + +### date\_created + +```ts +date_created: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L47) + +*** + +### date\_last\_active + +```ts +date_last_active: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L48) + +*** + +### enterprise\_id + +```ts +enterprise_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L44) + +*** + +### externally\_shared\_with\_organizations + +```ts +externally_shared_with_organizations: AdminAnalyticsExternallySharedWithOrganizationsDetails[]; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L61) + +*** + +### full\_members\_count + +```ts +full_members_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L50) + +*** + +### guest\_member\_count + +```ts +guest_member_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L51) + +*** + +### is\_shared\_externally + +```ts +is_shared_externally: boolean; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L59) + +*** + +### members\_who\_posted\_count + +```ts +members_who_posted_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L55) + +*** + +### members\_who\_viewed\_count + +```ts +members_who_viewed_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L54) + +*** + +### messages\_posted\_by\_members\_count + +```ts +messages_posted_by_members_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L53) + +*** + +### messages\_posted\_count + +```ts +messages_posted_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L52) + +*** + +### originating\_team + +```ts +originating_team: AdminAnalyticsOriginatingTeamDetails; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L45) + +*** + +### reactions\_added\_count + +```ts +reactions_added_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L56) + +*** + +### shared\_with + +```ts +shared_with: AdminAnalyticsSharedWithDetails[]; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L60) + +*** + +### total\_members\_count + +```ts +total_members_count: number; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L49) + +*** + +### visibility + +```ts +visibility: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L57) diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md new file mode 100644 index 000000000..6e4bbbdf4 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md @@ -0,0 +1,61 @@ +# Interface: AdminAnalyticsPublicChannelMetadataDetails + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L66) + +*** + +### date + +```ts +date: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L70) + +*** + +### description + +```ts +description: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L69) + +*** + +### name + +```ts +name: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L67) + +*** + +### topic + +```ts +topic: string; +``` + +#### Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L68) diff --git a/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md new file mode 100644 index 000000000..abec522a3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md @@ -0,0 +1,41 @@ +# Interface: AdminAppsConfigLookupArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### app\_ids + +```ts +app_ids: string[]; +``` + +#### Description + +An array of app IDs to get app configs for. + +#### Defined in + +[packages/web-api/src/types/request/admin/apps.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L67) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md b/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md new file mode 100644 index 000000000..a41fa5aab --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md @@ -0,0 +1,97 @@ +# Interface: AdminAppsConfigSetArguments + +## Extends + +- `AppID`.`TokenOverridable` + +## Properties + +### app\_id + +```ts +app_id: string; +``` + +#### Description + +The ID of the app. + +#### Inherited from + +`AppID.app_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) + +*** + +### domain\_restrictions? + +```ts +optional domain_restrictions: object; +``` + +#### emails? + +```ts +optional emails: string[]; +``` + +##### Description + +Sets emails for connector authorization. + +#### urls? + +```ts +optional urls: string[]; +``` + +##### Description + +Sets allowed URLs for the app. + +#### Description + +Domain restrictions for the app. + +#### Defined in + +[packages/web-api/src/types/request/admin/apps.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L73) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_auth\_strategy? + +```ts +optional workflow_auth_strategy: "builder_choice" | "end_user_only"; +``` + +#### Description + +The workflow auth permission. + +#### Defined in + +[packages/web-api/src/types/request/admin/apps.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L80) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md new file mode 100644 index 000000000..f0d0cc845 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md @@ -0,0 +1,85 @@ +# Interface: AdminAuthPolicyAssignEntitiesArguments + +## Extends + +- `EntityIDs`.`EntityType`.`PolicyName`.`TokenOverridable` + +## Properties + +### entity\_ids + +```ts +entity_ids: string[]; +``` + +#### Description + +Encoded IDs of the entities interacting with. + +#### Inherited from + +`EntityIDs.entity_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L5) + +*** + +### entity\_type + +```ts +entity_type: "USER"; +``` + +#### Description + +The type of entity interacting with the policy. + +#### Inherited from + +`EntityType.entity_type` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) + +*** + +### policy\_name + +```ts +policy_name: "email_password"; +``` + +#### Description + +The name of the policy. + +#### Inherited from + +`PolicyName.policy_name` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md new file mode 100644 index 000000000..f8f0839d2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md @@ -0,0 +1,112 @@ +# Interface: AdminAuthPolicyGetEntitiesArguments + +## Extends + +- `Partial`\<`EntityType`\>.`PolicyName`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### entity\_type? + +```ts +optional entity_type: "USER"; +``` + +#### Description + +The type of entity interacting with the policy. + +#### Inherited from + +`Partial.entity_type` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### policy\_name + +```ts +policy_name: "email_password"; +``` + +#### Description + +The name of the policy. + +#### Inherited from + +`PolicyName.policy_name` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md new file mode 100644 index 000000000..f31b7893e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md @@ -0,0 +1,85 @@ +# Interface: AdminAuthPolicyRemoveEntitiesArguments + +## Extends + +- `EntityIDs`.`EntityType`.`PolicyName`.`TokenOverridable` + +## Properties + +### entity\_ids + +```ts +entity_ids: string[]; +``` + +#### Description + +Encoded IDs of the entities interacting with. + +#### Inherited from + +`EntityIDs.entity_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L5) + +*** + +### entity\_type + +```ts +entity_type: "USER"; +``` + +#### Description + +The type of entity interacting with the policy. + +#### Inherited from + +`EntityType.entity_type` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) + +*** + +### policy\_name + +```ts +policy_name: "email_password"; +``` + +#### Description + +The name of the policy. + +#### Inherited from + +`PolicyName.policy_name` + +#### Defined in + +[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md new file mode 100644 index 000000000..7679d444d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md @@ -0,0 +1,78 @@ +# Interface: AdminBarriersCreateArguments + +## Extends + +- `TokenOverridable` + +## Extended by + +- [`AdminBarriersUpdateArguments`](AdminBarriersUpdateArguments.md) + +## Properties + +### barriered\_from\_usergroup\_ids + +```ts +barriered_from_usergroup_ids: string[]; +``` + +#### Description + +A list of [IDP Groups](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) IDs ti associate with the barrier. + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L13) + +*** + +### primary\_usergroup\_id + +```ts +primary_usergroup_id: string; +``` + +#### Description + +The ID of the primary [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org). + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L15) + +*** + +### restricted\_subjects + +```ts +restricted_subjects: ["im", "mpim", "call"]; +``` + +#### Description + +What kind of interactions are blocked by this barrier? +Currently you must provide all three: `im`, `mpim`, `call`. + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L20) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md new file mode 100644 index 000000000..2c6f1557b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminBarriersDeleteArguments + +## Extends + +- `BarrierID`.`TokenOverridable` + +## Properties + +### barrier\_id + +```ts +barrier_id: string; +``` + +#### Description + +The ID of the barrier. + +#### Inherited from + +`BarrierID.barrier_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L7) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md new file mode 100644 index 000000000..3e54f0521 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md @@ -0,0 +1,106 @@ +# Interface: AdminBarriersUpdateArguments + +## Extends + +- [`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).`BarrierID` + +## Properties + +### barrier\_id + +```ts +barrier_id: string; +``` + +#### Description + +The ID of the barrier. + +#### Inherited from + +`BarrierID.barrier_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L7) + +*** + +### barriered\_from\_usergroup\_ids + +```ts +barriered_from_usergroup_ids: string[]; +``` + +#### Description + +A list of [IDP Groups](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) IDs ti associate with the barrier. + +#### Inherited from + +[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`barriered_from_usergroup_ids`](AdminBarriersCreateArguments.md#barriered_from_usergroup_ids) + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L13) + +*** + +### primary\_usergroup\_id + +```ts +primary_usergroup_id: string; +``` + +#### Description + +The ID of the primary [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org). + +#### Inherited from + +[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`primary_usergroup_id`](AdminBarriersCreateArguments.md#primary_usergroup_id) + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L15) + +*** + +### restricted\_subjects + +```ts +restricted_subjects: ["im", "mpim", "call"]; +``` + +#### Description + +What kind of interactions are blocked by this barrier? +Currently you must provide all three: `im`, `mpim`, `call`. + +#### Inherited from + +[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`restricted_subjects`](AdminBarriersCreateArguments.md#restricted_subjects) + +#### Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L20) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`token`](AdminBarriersCreateArguments.md#token) + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md new file mode 100644 index 000000000..906c3e87b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsArchiveArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md new file mode 100644 index 000000000..8ec302696 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsBulkArchiveArguments + +## Extends + +- `ChannelIDs`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md new file mode 100644 index 000000000..153321b51 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsBulkDeleteArguments + +## Extends + +- `ChannelIDs`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md new file mode 100644 index 000000000..412b9c42f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsBulkMoveArguments + +## Extends + +- `ChannelIDs`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### target\_team\_id + +```ts +target_team_id: string; +``` + +#### Description + +Target team ID to move channels to. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L49) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md new file mode 100644 index 000000000..15fd96796 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsConvertToPrivateArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### name? + +```ts +optional name: string; +``` + +#### Description + +Name of private channel to create. Only respected when converting an MPIM. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L55) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md new file mode 100644 index 000000000..cb1433f75 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsConvertToPublicArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md new file mode 100644 index 000000000..5b43bce23 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsDeleteArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md new file mode 100644 index 000000000..9e8f8922f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsDisconnectSharedArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### leaving\_team\_ids? + +```ts +optional leaving_team_ids: string[]; +``` + +#### Description + +Team IDs getting removed from the channel, optional if there are only two teams in the channel. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L96) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md new file mode 100644 index 000000000..0620a4d5e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsGetConversationPrefsArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md new file mode 100644 index 000000000..fb682bc2a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsGetCustomRetentionArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md new file mode 100644 index 000000000..59cc9857f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminConversationsGetTeamsArguments + +## Extends + +- `ChannelID`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md new file mode 100644 index 000000000..8ce7fa640 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminConversationsInviteArguments + +## Extends + +- `ChannelID`.`UserIDs`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md new file mode 100644 index 000000000..d3f655d1c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md @@ -0,0 +1,125 @@ +# Interface: AdminConversationsLookupArguments + +## Extends + +- `TeamIDs`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### last\_message\_activity\_before + +```ts +last_message_activity_before: number; +``` + +#### Description + +UNIX timestamp to filter by public channels where the most recent message +was sent before this parameter. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L126) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### max\_member\_count? + +```ts +optional max_member_count: number; +``` + +#### Description + +Filter by public channels with member count equal to or less than the specified number. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L128) + +*** + +### team\_ids + +```ts +team_ids: [string, ...string[]]; +``` + +#### Description + +A list of team IDs to filter by (must include at least one ID). + +#### Inherited from + +`TeamIDs.team_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L25) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md new file mode 100644 index 000000000..abce17dab --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsRemoveCustomRetentionArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md new file mode 100644 index 000000000..424ab788f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsRenameArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +The new name for the channel. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:137](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L137) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md new file mode 100644 index 000000000..76f2fc486 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md @@ -0,0 +1,86 @@ +# Interface: AdminConversationsRestrictAccessAddGroupArguments + +## Extends + +- `ChannelID`.`GroupID`.`RestrictAccessTeamID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### group\_id + +```ts +group_id: string; +``` + +#### Description + +The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID. + +#### Inherited from + +`GroupID.group_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L20) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +The workspace where the channel exists. This argument is required for channels only tied to +one workspace, and optional for channels that are shared across an organization. + +#### Inherited from + +`RestrictAccessTeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md new file mode 100644 index 000000000..9d447847b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md @@ -0,0 +1,66 @@ +# Interface: AdminConversationsRestrictAccessListGroupsArguments + +## Extends + +- `ChannelID`.`RestrictAccessTeamID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +The workspace where the channel exists. This argument is required for channels only tied to +one workspace, and optional for channels that are shared across an organization. + +#### Inherited from + +`RestrictAccessTeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md new file mode 100644 index 000000000..226ebd12a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md @@ -0,0 +1,86 @@ +# Interface: AdminConversationsRestrictAccessRemoveGroupArguments + +## Extends + +- `ChannelID`.`GroupID`.`RestrictAccessTeamID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### group\_id + +```ts +group_id: string; +``` + +#### Description + +The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID. + +#### Inherited from + +`GroupID.group_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L20) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +The workspace where the channel exists. This argument is required for channels only tied to +one workspace, and optional for channels that are shared across an organization. + +#### Inherited from + +`RestrictAccessTeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md new file mode 100644 index 000000000..0442f6ee6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsSetConversationPrefsArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### prefs + +```ts +prefs: Record; +``` + +#### Description + +The prefs for this channel. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:185](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L185) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md new file mode 100644 index 000000000..55e8c2061 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminConversationsSetCustomRetentionArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### duration\_days + +```ts +duration_days: number; +``` + +#### Description + +The message retention duration in days to set for this conversation. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L191) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md new file mode 100644 index 000000000..214f6ec8d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md @@ -0,0 +1,95 @@ +# Interface: AdminConversationsSetTeamsArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### org\_channel? + +```ts +optional org_channel: boolean; +``` + +#### Description + +Set to `true` if channel has to be converted to an org channel. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:197](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L197) + +*** + +### target\_team\_ids? + +```ts +optional target_team_ids: string[]; +``` + +#### Description + +A list of workspaces to which the channel should be shared. +Not required if the channel is being shared org-wide. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:202](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L202) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +The workspace to which the channel belongs. +Omit this argument if the channel is a cross-workspace shared channel. + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L207) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md new file mode 100644 index 000000000..fe41d476e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminConversationsUnarchiveArguments + +## Extends + +- `ChannelID`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Encoded channel ID. + +#### Inherited from + +`ChannelID.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md new file mode 100644 index 000000000..0e31d6c0b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md @@ -0,0 +1,63 @@ +# Interface: AdminEmojiAddAliasArguments + +## Extends + +- `Name`.`TokenOverridable` + +## Properties + +### alias\_for + +```ts +alias_for: string; +``` + +#### Description + +Name of the emoji for which the alias is being made. +Any wrapping whitespace or colons will be automatically trimmed. + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L28) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +The name of the emoji. Colons (:myemoji:) around the value are not required, +although they may be included. + +#### Inherited from + +`Name.name` + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md new file mode 100644 index 000000000..b70a4b1f1 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md @@ -0,0 +1,63 @@ +# Interface: AdminEmojiAddArguments + +## Extends + +- `Name`.`TokenOverridable` + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +The name of the emoji. Colons (:myemoji:) around the value are not required, +although they may be included. + +#### Inherited from + +`Name.name` + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### url + +```ts +url: string; +``` + +#### Description + +The URL of a file to use as an image for the emoji. +Square images under 128KB and with transparent backgrounds work best. + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L19) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md new file mode 100644 index 000000000..96c936421 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md @@ -0,0 +1,46 @@ +# Interface: AdminEmojiRemoveArguments + +## Extends + +- `Name`.`TokenOverridable` + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +The name of the emoji. Colons (:myemoji:) around the value are not required, +although they may be included. + +#### Inherited from + +`Name.name` + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md new file mode 100644 index 000000000..20495fa25 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md @@ -0,0 +1,62 @@ +# Interface: AdminEmojiRenameArguments + +## Extends + +- `Name`.`TokenOverridable` + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +The name of the emoji. Colons (:myemoji:) around the value are not required, +although they may be included. + +#### Inherited from + +`Name.name` + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) + +*** + +### new\_name + +```ts +new_name: string; +``` + +#### Description + +The new name of the emoji. + +#### Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L40) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md new file mode 100644 index 000000000..fafa9d02b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md @@ -0,0 +1,104 @@ +# Interface: AdminFunctionsListArguments + +## Extends + +- `TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### app\_ids + +```ts +app_ids: string[]; +``` + +#### Description + +Array of app IDs to get functions for; max 50. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L6) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +The team context to retrieve functions from. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L8) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md new file mode 100644 index 000000000..2c0e54f13 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md @@ -0,0 +1,41 @@ +# Interface: AdminFunctionsPermissionsLookupArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### function\_ids + +```ts +function_ids: [string, ...string[]]; +``` + +#### Description + +An array of function IDs to get permissions for. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L15) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md new file mode 100644 index 000000000..ad9739b4d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md @@ -0,0 +1,73 @@ +# Interface: AdminFunctionsPermissionsSetArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### function\_id + +```ts +function_id: string; +``` + +#### Description + +The function ID to set permissions for. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L21) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids? + +```ts +optional user_ids: string[]; +``` + +#### Description + +List of user IDs to allow for `named_entities` visibility. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L25) + +*** + +### visibility + +```ts +visibility: "everyone" | "app_collaborators" | "named_entities" | "no_one"; +``` + +#### Description + +The function visibility. + +#### Defined in + +[packages/web-api/src/types/request/admin/functions.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md new file mode 100644 index 000000000..133cd49a9 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminInviteRequestsApproveArguments + +## Extends + +- `InviteRequestID`.`Required`\<`OptionalTeamAssignable`\>.`TokenOverridable` + +## Properties + +### invite\_request\_id + +```ts +invite_request_id: string; +``` + +#### Description + +ID of the request to invite. + +#### Inherited from + +`InviteRequestID.invite_request_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/inviteRequests.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/inviteRequests.ts#L5) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Required.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md new file mode 100644 index 000000000..11a7852a3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminInviteRequestsApprovedListArguments + +## Extends + +- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Required.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md new file mode 100644 index 000000000..e8e7d4bd0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminInviteRequestsDeniedListArguments + +## Extends + +- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Required.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md new file mode 100644 index 000000000..7ca38e6f3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminInviteRequestsDenyArguments + +## Extends + +- `InviteRequestID`.`Required`\<`OptionalTeamAssignable`\>.`TokenOverridable` + +## Properties + +### invite\_request\_id + +```ts +invite_request_id: string; +``` + +#### Description + +ID of the request to invite. + +#### Inherited from + +`InviteRequestID.invite_request_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/inviteRequests.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/inviteRequests.ts#L5) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Required.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md new file mode 100644 index 000000000..707a1c849 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminInviteRequestsListArguments + +## Extends + +- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Required.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md b/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md new file mode 100644 index 000000000..46fd90a7e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md @@ -0,0 +1,90 @@ +# Interface: AdminRolesAddAssignmentsArguments + +## Extends + +- `EntityIDs`.`RoleID`.`UserIDs`.`TokenOverridable` + +## Properties + +### entity\_ids + +```ts +entity_ids: [string, ...string[]]; +``` + +#### Description + +List of the entity IDs for which roles will be assigned/listed/removed. +These can be Org IDs (E12345), Team IDs (T12345) or Channel IDs (C12345). + +#### Inherited from + +`EntityIDs.entity_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/roles.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L10) + +*** + +### role\_id + +```ts +role_id: string; +``` + +#### Description + +ID of the role to which users will be assigned/removed. + +#### See + +[Admin Roles under Usage info](https://api.slack.com/methods/admin.roles.addAssignments#markdown). + +#### Inherited from + +`RoleID.role_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/roles.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L18) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md b/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md new file mode 100644 index 000000000..52f719fa0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md @@ -0,0 +1,90 @@ +# Interface: AdminRolesRemoveAssignmentsArguments + +## Extends + +- `EntityIDs`.`RoleID`.`UserIDs`.`TokenOverridable` + +## Properties + +### entity\_ids + +```ts +entity_ids: [string, ...string[]]; +``` + +#### Description + +List of the entity IDs for which roles will be assigned/listed/removed. +These can be Org IDs (E12345), Team IDs (T12345) or Channel IDs (C12345). + +#### Inherited from + +`EntityIDs.entity_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/roles.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L10) + +*** + +### role\_id + +```ts +role_id: string; +``` + +#### Description + +ID of the role to which users will be assigned/removed. + +#### See + +[Admin Roles under Usage info](https://api.slack.com/methods/admin.roles.addAssignments#markdown). + +#### Inherited from + +`RoleID.role_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/roles.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L18) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md new file mode 100644 index 000000000..26ccf9070 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminTeamsAdminsListArguments + +## Extends + +- `TeamID`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md new file mode 100644 index 000000000..976a5e4be --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md @@ -0,0 +1,89 @@ +# Interface: AdminTeamsCreateArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### team\_description? + +```ts +optional team_description: string; +``` + +#### Description + +Description for the team. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L17) + +*** + +### team\_discoverability? + +```ts +optional team_discoverability: TeamDiscoverability; +``` + +#### Description + +Who can join the team. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L19) + +*** + +### team\_domain + +```ts +team_domain: string; +``` + +#### Description + +Team domain (for example, slacksoftballteam). Domains are limited to 21 characters. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L13) + +*** + +### team\_name + +```ts +team_name: string; +``` + +#### Description + +Team name (for example, Slack Softball Team). + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L15) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md new file mode 100644 index 000000000..d17521e0d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md @@ -0,0 +1,92 @@ +# Interface: AdminTeamsOwnersListArguments + +## Extends + +- `TeamID`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md new file mode 100644 index 000000000..8519fbefb --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminTeamsSettingsInfoArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md new file mode 100644 index 000000000..2371b4f5f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminTeamsSettingsSetDefaultChannelsArguments + +## Extends + +- `ChannelIDs`.`TeamID`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md new file mode 100644 index 000000000..2187f7a97 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminTeamsSettingsSetDescriptionArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### description + +```ts +description: string; +``` + +#### Description + +The new description for the workspace. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L37) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md new file mode 100644 index 000000000..01c68ac97 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminTeamsSettingsSetDiscoverabilityArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### discoverability + +```ts +discoverability: TeamDiscoverability; +``` + +#### Description + +This workspace's discovery setting. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L43) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md new file mode 100644 index 000000000..41ae961ef --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminTeamsSettingsSetIconArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### image\_url + +```ts +image_url: string; +``` + +#### Description + +Image URL for the icon. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L49) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md new file mode 100644 index 000000000..745e6976b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminTeamsSettingsSetNameArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +The new name of the workspace. + +#### Defined in + +[packages/web-api/src/types/request/admin/teams.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L55) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md new file mode 100644 index 000000000..bd3a315b1 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md @@ -0,0 +1,85 @@ +# Interface: AdminUsergroupsAddChannelsArguments + +## Extends + +- `ChannelIDs`.`UsergroupID`.`OptionalTeamAssignable`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: string | string[]; +``` + +#### Description + +One or more encoded channel IDs. + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L5) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +ID of the IDP group to list/manage channels for. + +#### Inherited from + +`UsergroupID.usergroup_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md new file mode 100644 index 000000000..52bbf0365 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md @@ -0,0 +1,79 @@ +# Interface: AdminUsergroupsAddTeamsArguments + +## Extends + +- `UsergroupID`.`TokenOverridable` + +## Properties + +### auto\_provision? + +```ts +optional auto_provision: boolean; +``` + +#### Description + +When `true`, this method automatically creates new workspace accounts for the IDP group members. +Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L28) + +*** + +### team\_ids + +```ts +team_ids: string | string[]; +``` + +#### Description + +One or more encoded team (workspace) IDs. +Each workspace MUST belong to the organization associated with the token. + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L23) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +ID of the IDP group to list/manage channels for. + +#### Inherited from + +`UsergroupID.usergroup_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md new file mode 100644 index 000000000..8d46eeac7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md @@ -0,0 +1,81 @@ +# Interface: AdminUsergroupsListChannelsArguments + +## Extends + +- `UsergroupID`.`OptionalTeamAssignable`.`TokenOverridable` + +## Properties + +### include\_num\_members? + +```ts +optional include_num_members: boolean; +``` + +#### Description + +Flag to include or exclude the count of members per channel. + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L34) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +ID of the IDP group to list/manage channels for. + +#### Inherited from + +`UsergroupID.usergroup_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md new file mode 100644 index 000000000..5e3bc2d32 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminUsergroupsRemoveChannelsArguments + +## Extends + +- `ChannelIDs`.`UsergroupID`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: string | string[]; +``` + +#### Description + +One or more encoded channel IDs. + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L5) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +ID of the IDP group to list/manage channels for. + +#### Inherited from + +`UsergroupID.usergroup_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md new file mode 100644 index 000000000..3995d7dbf --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md @@ -0,0 +1,125 @@ +# Interface: AdminUsersAssignArguments + +## Extends + +- `TeamID`.`UserID`.`Partial`\<`ChannelIDs`\>.`IsRestricted`.`IsUltraRestricted`.`TokenOverridable` + +## Properties + +### channel\_ids? + +```ts +optional channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`Partial.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### is\_restricted? + +```ts +optional is_restricted: boolean; +``` + +#### Description + +Set to `true` if user should be added to the workspace as a guest. + +#### Inherited from + +`IsRestricted.is_restricted` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L19) + +*** + +### is\_ultra\_restricted? + +```ts +optional is_ultra_restricted: boolean; +``` + +#### Description + +Set to `true` if user should be added to the workspace as a guest. + +#### Inherited from + +`IsUltraRestricted.is_ultra_restricted` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L24) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md new file mode 100644 index 000000000..581615ee7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md @@ -0,0 +1,204 @@ +# Interface: AdminUsersInviteArguments + +## Extends + +- `ChannelIDs`.`TeamID`.`IsRestricted`.`IsUltraRestricted`.`TokenOverridable` + +## Properties + +### channel\_ids + +```ts +channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`ChannelIDs.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### custom\_message? + +```ts +optional custom_message: string; +``` + +#### Description + +An optional message to send to the user in the invite email. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L67) + +*** + +### email + +```ts +email: string; +``` + +#### Description + +The email address of the person to invite. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L65) + +*** + +### email\_password\_policy\_enabled? + +```ts +optional email_password_policy_enabled: boolean; +``` + +#### Description + +Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via +admin invite. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:72](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L72) + +*** + +### guest\_expiration\_ts? + +```ts +optional guest_expiration_ts: string; +``` + +#### Description + +Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a +guest user and you want their account to expire on a certain date. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L77) + +*** + +### is\_restricted? + +```ts +optional is_restricted: boolean; +``` + +#### Description + +Set to `true` if user should be added to the workspace as a guest. + +#### Inherited from + +`IsRestricted.is_restricted` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L19) + +*** + +### is\_ultra\_restricted? + +```ts +optional is_ultra_restricted: boolean; +``` + +#### Description + +Set to `true` if user should be added to the workspace as a guest. + +#### Inherited from + +`IsUltraRestricted.is_ultra_restricted` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L24) + +*** + +### real\_name? + +```ts +optional real_name: string; +``` + +#### Description + +Full name of the user. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L79) + +*** + +### resend? + +```ts +optional resend: boolean; +``` + +#### Description + +Allow this invite to be resent in the future if a user has not signed up yet. +Resending can only be done via the UI and has no expiration. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L84) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md new file mode 100644 index 000000000..96bf30ece --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminUsersRemoveArguments + +## Extends + +- `TeamID`.`UserID`.`TokenOverridable` + +## Properties + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md new file mode 100644 index 000000000..b1601e18d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminUsersSessionClearSettingsArguments + +## Extends + +- `UserIDs`.`TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md new file mode 100644 index 000000000..9509010a4 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminUsersSessionGetSettingsArguments + +## Extends + +- `UserIDs`.`TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md new file mode 100644 index 000000000..0efc9a1da --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md @@ -0,0 +1,61 @@ +# Interface: AdminUsersSessionInvalidateArguments + +## Extends + +- `TeamID`.`TokenOverridable` + +## Properties + +### session\_id + +```ts +session_id: string; +``` + +#### Description + +ID of the session to invalidate. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L109) + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md new file mode 100644 index 000000000..d8caf3b63 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md @@ -0,0 +1,85 @@ +# Interface: AdminUsersSessionResetArguments + +## Extends + +- `UserID`.`SessionExpirationTarget`.`TokenOverridable` + +## Properties + +### mobile\_only? + +```ts +optional mobile_only: boolean; +``` + +#### Description + +Only expire mobile sessions. Defaults to `false`. + +#### Inherited from + +`SessionExpirationTarget.mobile_only` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L29) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) + +*** + +### web\_only? + +```ts +optional web_only: boolean; +``` + +#### Description + +Only expire web sessions. Defaults to `false`. + +#### Inherited from + +`SessionExpirationTarget.web_only` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L31) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md new file mode 100644 index 000000000..2c4793494 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md @@ -0,0 +1,85 @@ +# Interface: AdminUsersSessionResetBulkArguments + +## Extends + +- `UserIDs`.`SessionExpirationTarget`.`TokenOverridable` + +## Properties + +### mobile\_only? + +```ts +optional mobile_only: boolean; +``` + +#### Description + +Only expire mobile sessions. Defaults to `false`. + +#### Inherited from + +`SessionExpirationTarget.mobile_only` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L29) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) + +*** + +### web\_only? + +```ts +optional web_only: boolean; +``` + +#### Description + +Only expire web sessions. Defaults to `false`. + +#### Inherited from + +`SessionExpirationTarget.web_only` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L31) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md new file mode 100644 index 000000000..99b58b021 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md @@ -0,0 +1,78 @@ +# Interface: AdminUsersSessionSetSettingsArguments + +## Extends + +- `UserIDs`.`TokenOverridable` + +## Properties + +### desktop\_app\_browser\_quit? + +```ts +optional desktop_app_browser_quit: boolean; +``` + +#### Description + +Terminate the session when the client—either the desktop app or a browser window—is closed. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L125) + +*** + +### duration? + +```ts +optional duration: number; +``` + +#### Description + +The session duration in seconds. The minimum value is 28800, which represents 8 hours; +the max value is 315569520 or 10 years (that's a long Slack session). + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L130) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids + +```ts +user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`UserIDs.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md new file mode 100644 index 000000000..ed54359c8 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminUsersSetAdminArguments + +## Extends + +- `TeamID`.`UserID`.`TokenOverridable` + +## Properties + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md new file mode 100644 index 000000000..5793106b6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md @@ -0,0 +1,81 @@ +# Interface: AdminUsersSetExpirationArguments + +## Extends + +- `UserID`.`TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### expiration\_ts + +```ts +expiration_ts: number; +``` + +#### Description + +Epoch timestamp in seconds when guest account should be disabled. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L139) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md new file mode 100644 index 000000000..1b11a0f55 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminUsersSetOwnerArguments + +## Extends + +- `TeamID`.`UserID`.`TokenOverridable` + +## Properties + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md new file mode 100644 index 000000000..bb2263af2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminUsersSetRegularArguments + +## Extends + +- `TeamID`.`UserID`.`TokenOverridable` + +## Properties + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID. + +#### Inherited from + +`TeamID.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The ID of the user. + +#### Inherited from + +`UserID.user_id` + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md new file mode 100644 index 000000000..84b13f977 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md @@ -0,0 +1,59 @@ +# Interface: AdminUsersUnsupportedVersionsExportArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### date\_end\_of\_support? + +```ts +optional date_end_of_support: number; +``` + +#### Description + +Unix timestamp of the date of past or upcoming end of support cycles. +If not provided will include all announced end of support cycles. Defaults to `0`. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L154) + +*** + +### date\_sessions\_started? + +```ts +optional date_sessions_started: number; +``` + +#### Description + +Unix timestamp of a date to start looking for user sessions. +If not provided will start six months ago. + +#### Defined in + +[packages/web-api/src/types/request/admin/users.ts:159](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L159) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md new file mode 100644 index 000000000..e5bad42e7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminWorkflowsCollaboratorsAddArguments + +## Extends + +- `CollaboratorIDs`.`WorkflowIDs`.`TokenOverridable` + +## Properties + +### collaborator\_ids + +```ts +collaborator_ids: [string, ...string[]]; +``` + +#### Description + +Array of collaborators (encoded user IDs) - maximum of 50 items. + +#### Inherited from + +`CollaboratorIDs.collaborator_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L7) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_ids + +```ts +workflow_ids: [string, ...string[]]; +``` + +#### Description + +Array of workflow IDs - maximum of 50 items. + +#### Inherited from + +`WorkflowIDs.workflow_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md new file mode 100644 index 000000000..ec0efa9d5 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md @@ -0,0 +1,65 @@ +# Interface: AdminWorkflowsCollaboratorsRemoveArguments + +## Extends + +- `CollaboratorIDs`.`WorkflowIDs`.`TokenOverridable` + +## Properties + +### collaborator\_ids + +```ts +collaborator_ids: [string, ...string[]]; +``` + +#### Description + +Array of collaborators (encoded user IDs) - maximum of 50 items. + +#### Inherited from + +`CollaboratorIDs.collaborator_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L7) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_ids + +```ts +workflow_ids: [string, ...string[]]; +``` + +#### Description + +Array of workflow IDs - maximum of 50 items. + +#### Inherited from + +`WorkflowIDs.workflow_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md new file mode 100644 index 000000000..97043d9d6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md @@ -0,0 +1,62 @@ +# Interface: AdminWorkflowsPermissionsLookupArguments + +## Extends + +- `WorkflowIDs`.`TokenOverridable` + +## Properties + +### max\_workflow\_triggers? + +```ts +optional max_workflow_triggers: number; +``` + +#### Description + +Maximum number of triggers to fetch for each workflow when determining overall run permissions. +Defaults to `100`. Maximum of `1000`. + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L27) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_ids + +```ts +workflow_ids: [string, ...string[]]; +``` + +#### Description + +Array of workflow IDs - maximum of 50 items. + +#### Inherited from + +`WorkflowIDs.workflow_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md new file mode 100644 index 000000000..d335489b5 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md @@ -0,0 +1,45 @@ +# Interface: AdminWorkflowsUnpublishArguments + +## Extends + +- `WorkflowIDs`.`TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_ids + +```ts +workflow_ids: [string, ...string[]]; +``` + +#### Description + +Array of workflow IDs - maximum of 50 items. + +#### Inherited from + +`WorkflowIDs.workflow_ids` + +#### Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md b/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md new file mode 100644 index 000000000..5b727cec2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md @@ -0,0 +1,84 @@ +# Interface: AppsEventAuthorizationsListArguments + +## Extends + +- `TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### event\_context + +```ts +event_context: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/apps.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L12) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md new file mode 100644 index 000000000..5270f4d5b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md @@ -0,0 +1,37 @@ +# Interface: AppsManifestCreateArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### manifest + +```ts +manifest: Manifest; +``` + +#### Defined in + +[packages/web-api/src/types/request/apps.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L17) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md new file mode 100644 index 000000000..710922803 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: AppsManifestDeleteArguments + +## Extends + +- `AppID`.`TokenOverridable` + +## Properties + +### app\_id + +```ts +app_id: string; +``` + +#### Description + +The ID of the app. + +#### Inherited from + +`AppID.app_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md new file mode 100644 index 000000000..16528a740 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md @@ -0,0 +1,45 @@ +# Interface: AppsManifestExportArguments + +## Extends + +- `AppID`.`TokenOverridable` + +## Properties + +### app\_id + +```ts +app_id: string; +``` + +#### Description + +The ID of the app. + +#### Inherited from + +`AppID.app_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md new file mode 100644 index 000000000..ce96306d7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md @@ -0,0 +1,57 @@ +# Interface: AppsManifestUpdateArguments + +## Extends + +- `AppID`.`TokenOverridable` + +## Properties + +### app\_id + +```ts +app_id: string; +``` + +#### Description + +The ID of the app. + +#### Inherited from + +`AppID.app_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) + +*** + +### manifest + +```ts +manifest: Manifest; +``` + +#### Defined in + +[packages/web-api/src/types/request/apps.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L28) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md new file mode 100644 index 000000000..426bc3cf5 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md @@ -0,0 +1,57 @@ +# Interface: AppsManifestValidateArguments + +## Extends + +- `Partial`\<`AppID`\>.`TokenOverridable` + +## Properties + +### app\_id? + +```ts +optional app_id: string; +``` + +#### Description + +The ID of the app. + +#### Inherited from + +`Partial.app_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) + +*** + +### manifest + +```ts +manifest: Manifest; +``` + +#### Defined in + +[packages/web-api/src/types/request/apps.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L33) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md b/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md new file mode 100644 index 000000000..a68efc286 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md @@ -0,0 +1,45 @@ +# Interface: AppsUninstallArguments + +## Extends + +- `Pick`\<`OAuthCredentials`, `"client_id"` \| `"client_secret"`\> + +## Properties + +### client\_id + +```ts +client_id: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`Pick.client_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) + +*** + +### client\_secret + +```ts +client_secret: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`Pick.client_secret` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) diff --git a/docs/content/reference/web-api/interfaces/AttachmentAction.md b/docs/content/reference/web-api/interfaces/AttachmentAction.md new file mode 100644 index 000000000..a5f483b61 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/AttachmentAction.md @@ -0,0 +1,162 @@ +# Interface: AttachmentAction + +## Properties + +### confirm? + +```ts +optional confirm: Confirmation; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:140 + +*** + +### data\_source? + +```ts +optional data_source: + | "channels" + | "users" + | "conversations" + | "external" + | "static"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:141 + +*** + +### id? + +```ts +optional id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:139 + +*** + +### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:142 + +*** + +### name? + +```ts +optional name: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:143 + +*** + +### option\_groups? + +```ts +optional option_groups: object[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:145 + +*** + +### options? + +```ts +optional options: OptionField[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:144 + +*** + +### selected\_options? + +```ts +optional selected_options: OptionField[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:149 + +*** + +### style? + +```ts +optional style: "danger" | "default" | "primary"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:150 + +*** + +### text + +```ts +text: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:151 + +*** + +### type + +```ts +type: "select" | "button"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:152 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:154 + +*** + +### value? + +```ts +optional value: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:153 diff --git a/docs/content/reference/web-api/interfaces/Block.md b/docs/content/reference/web-api/interfaces/Block.md new file mode 100644 index 000000000..ccb8a7564 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Block.md @@ -0,0 +1,45 @@ +# Interface: Block + +## Extended by + +- [`ActionsBlock`](ActionsBlock.md) +- [`ContextBlock`](ContextBlock.md) +- [`DividerBlock`](DividerBlock.md) +- [`FileBlock`](FileBlock.md) +- [`HeaderBlock`](HeaderBlock.md) +- [`InputBlock`](InputBlock.md) +- [`SectionBlock`](SectionBlock.md) +- [`VideoBlock`](VideoBlock.md) +- [`RichTextBlock`](RichTextBlock.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### type + +```ts +type: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:5 diff --git a/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md b/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md new file mode 100644 index 000000000..c527723da --- /dev/null +++ b/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md @@ -0,0 +1,153 @@ +# Interface: BookmarksAddArguments + +## Extends + +- `Channel`.`BookmarkFields`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Channel containing bookmark. + +#### Inherited from + +`Channel.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) + +*** + +### emoji? + +```ts +optional emoji: string; +``` + +#### Description + +Emoji tag to apply to the bookmark. + +#### Inherited from + +`BookmarkFields.emoji` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L16) + +*** + +### entity\_id? + +```ts +optional entity_id: string; +``` + +#### Description + +ID of the entity being bookmarked. Only applies to message and file types. + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L24) + +*** + +### link + +```ts +link: string; +``` + +#### Description + +Link to bookmark. + +#### Inherited from + +`BookmarkFields.link` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L14) + +*** + +### parent\_id? + +```ts +optional parent_id: string; +``` + +#### Description + +ID of this bookmark's parent. + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L26) + +*** + +### title + +```ts +title: string; +``` + +#### Description + +Title for the bookmark. + +#### Inherited from + +`BookmarkFields.title` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L12) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### type + +```ts +type: "link"; +``` + +#### Description + +Type of the bookmark. Only `link` is supported at the moment. + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L22) diff --git a/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md b/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md new file mode 100644 index 000000000..069f85300 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md @@ -0,0 +1,121 @@ +# Interface: BookmarksEditArguments + +## Extends + +- `Channel`.`ID`.`Partial`\<`BookmarkFields`\>.`TokenOverridable` + +## Properties + +### bookmark\_id + +```ts +bookmark_id: string; +``` + +#### Inherited from + +`ID.bookmark_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L8) + +*** + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Channel containing bookmark. + +#### Inherited from + +`Channel.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) + +*** + +### emoji? + +```ts +optional emoji: string; +``` + +#### Description + +Emoji tag to apply to the bookmark. + +#### Inherited from + +`Partial.emoji` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L16) + +*** + +### link? + +```ts +optional link: string; +``` + +#### Description + +Link to bookmark. + +#### Inherited from + +`Partial.link` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L14) + +*** + +### title? + +```ts +optional title: string; +``` + +#### Description + +Title for the bookmark. + +#### Inherited from + +`Partial.title` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L12) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/BookmarksListArguments.md b/docs/content/reference/web-api/interfaces/BookmarksListArguments.md new file mode 100644 index 000000000..35415ac6f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/BookmarksListArguments.md @@ -0,0 +1,45 @@ +# Interface: BookmarksListArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Channel containing bookmark. + +#### Inherited from + +`Channel.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md b/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md new file mode 100644 index 000000000..3b057e5e0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md @@ -0,0 +1,61 @@ +# Interface: BookmarksRemoveArguments + +## Extends + +- `Channel`.`ID`.`TokenOverridable` + +## Properties + +### bookmark\_id + +```ts +bookmark_id: string; +``` + +#### Inherited from + +`ID.bookmark_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L8) + +*** + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Channel containing bookmark. + +#### Inherited from + +`Channel.channel_id` + +#### Defined in + +[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Button.md b/docs/content/reference/web-api/interfaces/Button.md new file mode 100644 index 000000000..f2b6b2c81 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Button.md @@ -0,0 +1,165 @@ +# Interface: Button + +## Description + +Allows users a direct path to performing basic actions. + +## See + + - [Button element reference](https://api.slack.com/reference/block-kit/block-elements#button). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) + +## Properties + +### accessibility\_label? + +```ts +optional accessibility_label: string; +``` + +#### Description + +A label for longer descriptive text about a button element. This label will be read out by screen +readers instead of the button `text` object. Maximum length for this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:43 + +*** + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### style? + +```ts +optional style: "danger" | "primary"; +``` + +#### Description + +Decorates buttons with alternative visual color schemes. Use this option with restraint. +`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should +only be used for one button within a set. +`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even +more sparingly than primary. +If you don't include this field, the default button style will be used. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:38 + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. +Maximum length for the text in this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:18 + +*** + +### type + +```ts +type: "button"; +``` + +#### Description + +The type of element. In this case `type` is always `button`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:13 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 +characters. If you're using `url`, you'll still receive an [interaction payload](https://api.slack.com/interactivity/handling#payloads) +and will need to send an [acknowledgement response](https://api.slack.com/interactivity/handling#acknowledgment_response). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:29 + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +The value to send along with the [interaction payload](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 2000 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:23 diff --git a/docs/content/reference/web-api/interfaces/CallUserExternal.md b/docs/content/reference/web-api/interfaces/CallUserExternal.md new file mode 100644 index 000000000..989e4136d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallUserExternal.md @@ -0,0 +1,49 @@ +# Interface: CallUserExternal + +## Properties + +### avatar\_url? + +```ts +optional avatar_url: string; +``` + +#### Description + +URL to an avatar image of the user. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:24 + +*** + +### display\_name + +```ts +display_name: string; +``` + +#### Description + +Name of the user to be displayed in the Call block in a message. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:20 + +*** + +### external\_id + +```ts +external_id: string; +``` + +#### Description + +A unique ID created by your app to represent your users. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:16 diff --git a/docs/content/reference/web-api/interfaces/CallUserSlack.md b/docs/content/reference/web-api/interfaces/CallUserSlack.md new file mode 100644 index 000000000..844ccbcfd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallUserSlack.md @@ -0,0 +1,18 @@ +# Interface: CallUserSlack + +## Properties + +### slack\_id + +```ts +slack_id: string; +``` + +#### Description + +The Slack encoded user ID, e.g. U1234ABCD. Set this if you have it or know it, otherwise, set +`external_id` and `display_name`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:10 diff --git a/docs/content/reference/web-api/interfaces/CallsAddArguments.md b/docs/content/reference/web-api/interfaces/CallsAddArguments.md new file mode 100644 index 000000000..152caedb2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsAddArguments.md @@ -0,0 +1,176 @@ +# Interface: CallsAddArguments + +## Extends + +- `Partial`\<`Users`\>.`CallDetails`.`TokenOverridable` + +## Properties + +### created\_by? + +```ts +optional created_by: string; +``` + +#### Description + +ID of the user who created this Call. When this method is called with a user token, +this field is optional and defaults to the authed user of the token. Otherwise, the field is required. + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L37) + +*** + +### date\_start? + +```ts +optional date_start: number; +``` + +#### Description + +Unix timestamp of the call start time. + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L39) + +*** + +### desktop\_app\_join\_url? + +```ts +optional desktop_app_join_url: string; +``` + +#### Description + +When supplied, available Slack clients will attempt to directly launch the 3rd-party Call +with this URL. + +#### Inherited from + +`CallDetails.desktop_app_join_url` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L22) + +*** + +### external\_display\_id? + +```ts +optional external_display_id: string; +``` + +#### Description + +An optional, human-readable ID supplied by the 3rd-party Call provider. +If supplied, this ID will be displayed in the Call object. + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L44) + +*** + +### external\_unique\_id + +```ts +external_unique_id: string; +``` + +#### Description + +An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L32) + +*** + +### join\_url + +```ts +join_url: string; +``` + +#### Description + +The URL required for a client to join the Call. + +#### Inherited from + +`CallDetails.join_url` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L17) + +*** + +### title? + +```ts +optional title: string; +``` + +#### Description + +The name of the Call. + +#### Inherited from + +`CallDetails.title` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L24) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users? + +```ts +optional users: CallUser[]; +``` + +#### Description + +The list of users to add/remove to/from the Call. + +#### See + +[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). + +#### Inherited from + +`Partial.users` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsEndArguments.md b/docs/content/reference/web-api/interfaces/CallsEndArguments.md new file mode 100644 index 000000000..c269aa88e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsEndArguments.md @@ -0,0 +1,61 @@ +# Interface: CallsEndArguments + +## Extends + +- `ID`.`TokenOverridable` + +## Properties + +### duration? + +```ts +optional duration: number; +``` + +#### Description + +Call duration in seconds. + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L50) + +*** + +### id + +```ts +id: string; +``` + +#### Description + +`id` returned when registering the call using the `calls.add` method. + +#### Inherited from + +`ID.id` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CallsInfoArguments.md b/docs/content/reference/web-api/interfaces/CallsInfoArguments.md new file mode 100644 index 000000000..69d392620 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsInfoArguments.md @@ -0,0 +1,45 @@ +# Interface: CallsInfoArguments + +## Extends + +- `ID`.`TokenOverridable` + +## Properties + +### id + +```ts +id: string; +``` + +#### Description + +`id` returned when registering the call using the `calls.add` method. + +#### Inherited from + +`ID.id` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md b/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md new file mode 100644 index 000000000..2dcb00d7d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md @@ -0,0 +1,69 @@ +# Interface: CallsParticipantsAddArguments + +## Extends + +- `ID`.`Users`.`TokenOverridable` + +## Properties + +### id + +```ts +id: string; +``` + +#### Description + +`id` returned when registering the call using the `calls.add` method. + +#### Inherited from + +`ID.id` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users + +```ts +users: CallUser[]; +``` + +#### Description + +The list of users to add/remove to/from the Call. + +#### See + +[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). + +#### Inherited from + +`Users.users` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md b/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md new file mode 100644 index 000000000..9537096c7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md @@ -0,0 +1,69 @@ +# Interface: CallsParticipantsRemoveArguments + +## Extends + +- `ID`.`Users`.`TokenOverridable` + +## Properties + +### id + +```ts +id: string; +``` + +#### Description + +`id` returned when registering the call using the `calls.add` method. + +#### Inherited from + +`ID.id` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users + +```ts +users: CallUser[]; +``` + +#### Description + +The list of users to add/remove to/from the Call. + +#### See + +[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). + +#### Inherited from + +`Users.users` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md b/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md new file mode 100644 index 000000000..c1d6e48e1 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md @@ -0,0 +1,106 @@ +# Interface: CallsUpdateArguments + +## Extends + +- `ID`.`Partial`\<`CallDetails`\>.`TokenOverridable` + +## Properties + +### desktop\_app\_join\_url? + +```ts +optional desktop_app_join_url: string; +``` + +#### Description + +When supplied, available Slack clients will attempt to directly launch the 3rd-party Call +with this URL. + +#### Inherited from + +`Partial.desktop_app_join_url` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L22) + +*** + +### id + +```ts +id: string; +``` + +#### Description + +`id` returned when registering the call using the `calls.add` method. + +#### Inherited from + +`ID.id` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) + +*** + +### join\_url? + +```ts +optional join_url: string; +``` + +#### Description + +The URL required for a client to join the Call. + +#### Inherited from + +`Partial.join_url` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L17) + +*** + +### title? + +```ts +optional title: string; +``` + +#### Description + +The name of the Call. + +#### Inherited from + +`Partial.title` + +#### Defined in + +[packages/web-api/src/types/request/calls.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L24) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md b/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md new file mode 100644 index 000000000..d80b7444e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md @@ -0,0 +1,85 @@ +# Interface: CanvasesAccessDeleteArguments + +## Extends + +- `CanvasID`.`Partial`\<`ChannelIDs`\>.`TokenOverridable`.`Partial`\<`UserIDs`\> + +## Properties + +### canvas\_id + +```ts +canvas_id: string; +``` + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +`CanvasID.canvas_id` + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +*** + +### channel\_ids? + +```ts +optional channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`Partial.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids? + +```ts +optional user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`Partial.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md b/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md new file mode 100644 index 000000000..75f3f7086 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md @@ -0,0 +1,101 @@ +# Interface: CanvasesAccessSetArguments + +## Extends + +- `CanvasID`.`Partial`\<`ChannelIDs`\>.`TokenOverridable`.`Partial`\<`UserIDs`\> + +## Properties + +### access\_level + +```ts +access_level: "read" | "write"; +``` + +#### Description + +Desired level of access. + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L59) + +*** + +### canvas\_id + +```ts +canvas_id: string; +``` + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +`CanvasID.canvas_id` + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +*** + +### channel\_ids? + +```ts +optional channel_ids: [string, ...string[]]; +``` + +#### Description + +An array of channel IDs (must include at least one ID). + +#### Inherited from + +`Partial.channel_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_ids? + +```ts +optional user_ids: [string, ...string[]]; +``` + +#### Description + +List of encoded user IDs. + +#### Inherited from + +`Partial.user_ids` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md b/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md new file mode 100644 index 000000000..fae0bb0ef --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: CanvasesDeleteArguments + +## Extends + +- `CanvasID`.`TokenOverridable` + +## Properties + +### canvas\_id + +```ts +canvas_id: string; +``` + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +`CanvasID.canvas_id` + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md b/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md new file mode 100644 index 000000000..cc3e8f2dd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md @@ -0,0 +1,61 @@ +# Interface: CanvasesEditArguments + +## Extends + +- `CanvasID`.`TokenOverridable` + +## Properties + +### canvas\_id + +```ts +canvas_id: string; +``` + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +`CanvasID.canvas_id` + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +*** + +### changes + +```ts +changes: [Change, ...Change[]]; +``` + +#### Description + +List of changes to apply to the canvas. + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L82) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md b/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md new file mode 100644 index 000000000..a9f52527e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md @@ -0,0 +1,61 @@ +# Interface: CanvasesSectionsLookupArguments + +## Extends + +- `CanvasID`.`TokenOverridable` + +## Properties + +### canvas\_id + +```ts +canvas_id: string; +``` + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +`CanvasID.canvas_id` + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +*** + +### criteria + +```ts +criteria: Criteria; +``` + +#### Description + +Filtering criteria. + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L73) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChannelsSelect.md b/docs/content/reference/web-api/interfaces/ChannelsSelect.md new file mode 100644 index 000000000..dadf427dc --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ChannelsSelect.md @@ -0,0 +1,154 @@ +# Interface: ChannelsSelect + +## Description + +This select menu will populate its options with a list of public channels visible to the current user +in the active workspace. + +## See + + - [Select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channels_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_channel? + +```ts +optional initial_channel: string; +``` + +#### Description + +The ID of any valid public channel to be pre-selected when the menu loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:359 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### response\_url\_enabled? + +```ts +optional response_url_enabled: boolean; +``` + +#### Description + +When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) +from the menu's parent view will contain a `response_url`. This `response_url` can be used for +[message responses](https://api.slack.com/interactivity/handling#message_responses). The target channel +for the message will be determined by the value of this select menu. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:366 + +*** + +### type + +```ts +type: "channels_select"; +``` + +#### Description + +The type of element. In this case `type` is always `channels_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:355 diff --git a/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md b/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md new file mode 100644 index 000000000..899531281 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md @@ -0,0 +1,87 @@ +# Interface: ChatDeleteArguments + +## Extends + +- `ChannelAndTS`.`AsUser`.`TokenOverridable` + +## Properties + +### as\_user? + +```ts +optional as_user: boolean; +``` + +#### Description + +Pass `true` to act as the authed user with [`chat:write:user` scope](https://api.slack.com/scopes/chat:write:user). +Bot users in this context are considered authed users. If unused or `false`, the message will be acted upon with +[`chat:write:bot` scope](https://api.slack.com/scopes/chat:write:bot). + +#### Inherited from + +`AsUser.as_user` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L35) + +*** + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel ID for the message. + +#### Inherited from + +`ChannelAndTS.channel` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ts + +```ts +ts: string; +``` + +#### Description + +Timestamp of the message. + +#### Inherited from + +`ChannelAndTS.ts` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md b/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md new file mode 100644 index 000000000..8cdcf657d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md @@ -0,0 +1,83 @@ +# Interface: ChatDeleteScheduledMessageArguments + +## Extends + +- `Channel`.`AsUser`.`TokenOverridable` + +## Properties + +### as\_user? + +```ts +optional as_user: boolean; +``` + +#### Description + +Pass `true` to act as the authed user with [`chat:write:user` scope](https://api.slack.com/scopes/chat:write:user). +Bot users in this context are considered authed users. If unused or `false`, the message will be acted upon with +[`chat:write:bot` scope](https://api.slack.com/scopes/chat:write:bot). + +#### Inherited from + +`AsUser.as_user` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L35) + +*** + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel ID for the message. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) + +*** + +### scheduled\_message\_id + +```ts +scheduled_message_id: string; +``` + +#### Description + +The `scheduled_message_id` returned from call to [`chat.scheduleMessage`](https://api.slack.com/methods/chat.scheduleMessage). + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:151](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L151) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md b/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md new file mode 100644 index 000000000..854a782a2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md @@ -0,0 +1,65 @@ +# Interface: ChatGetPermalinkArguments + +## Extends + +- `ChannelAndMessageTS`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel ID for the message. + +#### Inherited from + +`ChannelAndMessageTS.channel` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) + +*** + +### message\_ts + +```ts +message_ts: string; +``` + +#### Description + +Timestamp of the message. + +#### Inherited from + +`ChannelAndMessageTS.message_ts` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L27) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md b/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md new file mode 100644 index 000000000..7929bb3fd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md @@ -0,0 +1,66 @@ +# Interface: ChatMeMessageArguments + +## Extends + +- `ChannelAndText`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel ID for the message. + +#### Inherited from + +`ChannelAndText.channel` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) + +*** + +### text + +```ts +text: string; +``` + +#### Description + +Text of the message. If used in conjunction with `blocks` or `attachments`, `text` will be used +as fallback text for notifications only. + +#### Inherited from + +`ChannelAndText.text` + +#### Defined in + +[packages/web-api/src/types/request/chat.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L53) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Checkboxes.md b/docs/content/reference/web-api/interfaces/Checkboxes.md new file mode 100644 index 000000000..dc88487b9 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Checkboxes.md @@ -0,0 +1,130 @@ +# Interface: Checkboxes + +## Description + +Allows users to choose multiple items from a list of options. + +## See + + - [Checkboxes element reference](https://api.slack.com/reference/block-kit/block-elements#checkboxes). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_options? + +```ts +optional initial_options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects that exactly matches one or more of the options within `options`. +These options will be selected when the checkbox group initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:59 + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:63 + +*** + +### type + +```ts +type: "checkboxes"; +``` + +#### Description + +The type of element. In this case `type` is always `checkboxes`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:54 diff --git a/docs/content/reference/web-api/interfaces/CodedError.md b/docs/content/reference/web-api/interfaces/CodedError.md new file mode 100644 index 000000000..db4248508 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/CodedError.md @@ -0,0 +1,126 @@ +# Interface: CodedError + +All errors produced by this package adhere to this interface + +## Extends + +- `ErrnoException` + +## Extended by + +- [`WebAPIPlatformError`](WebAPIPlatformError.md) +- [`WebAPIRequestError`](WebAPIRequestError.md) +- [`WebAPIHTTPError`](WebAPIHTTPError.md) +- [`WebAPIRateLimitedError`](WebAPIRateLimitedError.md) + +## Properties + +### code + +```ts +code: ErrorCode; +``` + +#### Overrides + +`NodeJS.ErrnoException.code` + +#### Defined in + +[packages/web-api/src/errors.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L11) + +*** + +### errno? + +```ts +optional errno: number; +``` + +#### Inherited from + +`NodeJS.ErrnoException.errno` + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:268 + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +`NodeJS.ErrnoException.message` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +`NodeJS.ErrnoException.name` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### path? + +```ts +optional path: string; +``` + +#### Inherited from + +`NodeJS.ErrnoException.path` + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:270 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +`NodeJS.ErrnoException.stack` + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + +### syscall? + +```ts +optional syscall: string; +``` + +#### Inherited from + +`NodeJS.ErrnoException.syscall` + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/Confirm.md b/docs/content/reference/web-api/interfaces/Confirm.md new file mode 100644 index 000000000..631ddd51d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Confirm.md @@ -0,0 +1,104 @@ +# Interface: ~~Confirm~~ + +## Deprecated + +[Confirm](Confirm.md) aliased to [ConfirmationDialog](ConfirmationDialog.md) in order to make the construct clearer +and line up terminology with api.slack.com. + +## Description + +Defines a dialog that adds a confirmation step to interactive elements. + +## See + +[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). + +## Extended by + +- [`ConfirmationDialog`](ConfirmationDialog.md) + +## Properties + +### ~~confirm?~~ + +```ts +optional confirm: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. +Maximum length for the `text` in this field is 30 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:22 + +*** + +### ~~deny?~~ + +```ts +optional deny: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. +Maximum length for the `text` in this field is 30 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:27 + +*** + +### ~~style?~~ + +```ts +optional style: "danger" | "primary"; +``` + +#### Description + +Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button +with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green +background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:33 + +*** + +### ~~text~~ + +```ts +text: PlainTextElement | MrkdwnElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm +dialog. Maximum length for the `text` in this field is 300 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:17 + +*** + +### ~~title?~~ + +```ts +optional title: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. +Maximum length for this field is 100 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:12 diff --git a/docs/content/reference/web-api/interfaces/Confirmable.md b/docs/content/reference/web-api/interfaces/Confirmable.md new file mode 100644 index 000000000..f94c6cd16 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Confirmable.md @@ -0,0 +1,39 @@ +# Interface: Confirmable + +## Extended by + +- [`Button`](Button.md) +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`Overflow`](Overflow.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`WorkflowButton`](WorkflowButton.md) + +## Properties + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 diff --git a/docs/content/reference/web-api/interfaces/Confirmation.md b/docs/content/reference/web-api/interfaces/Confirmation.md new file mode 100644 index 000000000..13e22dfe0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Confirmation.md @@ -0,0 +1,49 @@ +# Interface: Confirmation + +## Properties + +### dismiss\_text? + +```ts +optional dismiss_text: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:162 + +*** + +### ok\_text? + +```ts +optional ok_text: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:163 + +*** + +### text + +```ts +text: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:164 + +*** + +### title? + +```ts +optional title: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:165 diff --git a/docs/content/reference/web-api/interfaces/ConfirmationDialog.md b/docs/content/reference/web-api/interfaces/ConfirmationDialog.md new file mode 100644 index 000000000..e57f343ea --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConfirmationDialog.md @@ -0,0 +1,119 @@ +# Interface: ConfirmationDialog + +## Description + +Defines a dialog that adds a confirmation step to interactive elements. + +## See + +[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). + +## Extends + +- [`Confirm`](Confirm.md) + +## Properties + +### confirm? + +```ts +optional confirm: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. +Maximum length for the `text` in this field is 30 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`confirm`](Confirm.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:22 + +*** + +### deny? + +```ts +optional deny: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. +Maximum length for the `text` in this field is 30 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`deny`](Confirm.md#deny) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:27 + +*** + +### style? + +```ts +optional style: "danger" | "primary"; +``` + +#### Description + +Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button +with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green +background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. + +#### Inherited from + +[`Confirm`](Confirm.md).[`style`](Confirm.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:33 + +*** + +### text + +```ts +text: PlainTextElement | MrkdwnElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm +dialog. Maximum length for the `text` in this field is 300 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`text`](Confirm.md#text) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:17 + +*** + +### title? + +```ts +optional title: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. +Maximum length for this field is 100 characters. + +#### Inherited from + +[`Confirm`](Confirm.md).[`title`](Confirm.md#title) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:12 diff --git a/docs/content/reference/web-api/interfaces/ContextBlock.md b/docs/content/reference/web-api/interfaces/ContextBlock.md new file mode 100644 index 000000000..5f3d031f2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ContextBlock.md @@ -0,0 +1,74 @@ +# Interface: ContextBlock + +## Description + +Displays contextual info, which can include both images and text. + +## See + +[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### elements + +```ts +elements: (PlainTextElement | ImageElement | MrkdwnElement)[]; +``` + +#### Description + +An array of [ImageElement](../type-aliases/ImageElement.md), [PlainTextElement](PlainTextElement.md) or [MrkdwnElement](MrkdwnElement.md) objects. +Maximum number of items is 10. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:44 + +*** + +### type + +```ts +type: "context"; +``` + +#### Description + +The type of block. For a context block, `type` is always `context`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:39 diff --git a/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md new file mode 100644 index 000000000..9f68c9cfa --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md @@ -0,0 +1,65 @@ +# Interface: ConversationsApproveSharedInviteArguments + +## Extends + +- `InviteID`.`TargetTeam`.`TokenOverridable` + +## Properties + +### invite\_id + +```ts +invite_id: string; +``` + +#### Description + +ID of the invite. + +#### Inherited from + +`InviteID.invite_id` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L31) + +*** + +### target\_team? + +```ts +optional target_team: string; +``` + +#### Description + +The team or enterprise id of the other party. + +#### Inherited from + +`TargetTeam.target_team` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md new file mode 100644 index 000000000..522e256f2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md @@ -0,0 +1,45 @@ +# Interface: ConversationsArchiveArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md new file mode 100644 index 000000000..ef6809681 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md @@ -0,0 +1,57 @@ +# Interface: ConversationsCanvasesCreateArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +Channel ID of the channel to create a canvas in. + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L88) + +*** + +### document\_content? + +```ts +optional document_content: DocumentContent; +``` + +#### Description + +Structure describing the type and contents of the Canvas being created. + +#### Defined in + +[packages/web-api/src/types/request/canvas.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L90) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md new file mode 100644 index 000000000..2ae2a135a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md @@ -0,0 +1,45 @@ +# Interface: ConversationsCloseArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md new file mode 100644 index 000000000..67af36b4e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md @@ -0,0 +1,81 @@ +# Interface: ConversationsCreateArguments + +## Extends + +- `IsPrivate`.`TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### is\_private? + +```ts +optional is_private: boolean; +``` + +#### Description + +Whether the channel should be private. + +#### Inherited from + +`IsPrivate.is_private` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L35) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +Name of the public or private channel to create. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:74](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L74) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md new file mode 100644 index 000000000..97fe9ffd9 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md @@ -0,0 +1,65 @@ +# Interface: ConversationsDeclineSharedInviteArguments + +## Extends + +- `InviteID`.`TargetTeam`.`TokenOverridable` + +## Properties + +### invite\_id + +```ts +invite_id: string; +``` + +#### Description + +ID of the invite. + +#### Inherited from + +`InviteID.invite_id` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L31) + +*** + +### target\_team? + +```ts +optional target_team: string; +``` + +#### Description + +The team or enterprise id of the other party. + +#### Inherited from + +`TargetTeam.target_team` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md b/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md new file mode 100644 index 000000000..e8527552d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md @@ -0,0 +1,81 @@ +# Interface: ConversationsExternalInvitePermissionsSetArguments + +## Extends + +- `Channel`.`Required`\<`TargetTeam`\>.`TokenOverridable` + +## Properties + +### action + +```ts +action: "downgrade" | "upgrade"; +``` + +#### Description + +The type of action be taken: `upgrade` or `downgrade`. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L84) + +*** + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### target\_team + +```ts +target_team: string; +``` + +#### Description + +The team or enterprise id of the other party. + +#### Inherited from + +`Required.target_team` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md b/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md new file mode 100644 index 000000000..4933d5345 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md @@ -0,0 +1,173 @@ +# Interface: ConversationsHistoryArguments + +## Extends + +- `Channel`.`IncludeAllMetadata`.`TokenOverridable`.`CursorPaginationEnabled`.`TimelinePaginationEnabled` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### include\_all\_metadata? + +```ts +optional include_all_metadata: boolean; +``` + +#### Description + +Return all metadata associated with messages. Defaults to `false`. + +#### Inherited from + +`IncludeAllMetadata.include_all_metadata` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L27) + +*** + +### inclusive? + +```ts +optional inclusive: boolean; +``` + +#### Description + +Include messages with `oldest` or `latest` timestamps in results. +Ignored unless either timestamp is specified. Defaults to `false`. + +#### Inherited from + +`TimelinePaginationEnabled.inclusive` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L28) + +*** + +### latest? + +```ts +optional latest: string; +``` + +#### Description + +Only messages before this Unix timestamp will be included in results. + +#### Inherited from + +`TimelinePaginationEnabled.latest` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L23) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### oldest? + +```ts +optional oldest: string; +``` + +#### Description + +Only messages after this Unix timestamp will be included in results. + +#### Inherited from + +`TimelinePaginationEnabled.oldest` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L21) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md b/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md new file mode 100644 index 000000000..208a9ef79 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md @@ -0,0 +1,81 @@ +# Interface: ConversationsInfoArguments + +## Extends + +- `Channel`.`TokenOverridable`.`LocaleAware` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### include\_locale? + +```ts +optional include_locale: boolean; +``` + +#### Description + +Set this to `true` to receive the locale with the response. + +#### Inherited from + +`LocaleAware.include_locale` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) + +*** + +### include\_num\_members? + +```ts +optional include_num_members: boolean; +``` + +#### Description + +Set to `true` to include the member count for the specified conversation. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L96) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md new file mode 100644 index 000000000..8047a1fef --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md @@ -0,0 +1,82 @@ +# Interface: ConversationsInviteArguments + +## Extends + +- `Channel`.`Users`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### force? + +```ts +optional force: boolean; +``` + +#### Description + +When set to `true` and multiple user IDs are provided, continue inviting the valid ones while +disregarding invalid IDs. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L105) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users + +```ts +users: string; +``` + +#### Description + +A comma separated list of user IDs. Up to 1000 users may be listed. + +#### Inherited from + +`Users.users` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L48) diff --git a/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md b/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md new file mode 100644 index 000000000..3b4680d70 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md @@ -0,0 +1,45 @@ +# Interface: ConversationsJoinArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md b/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md new file mode 100644 index 000000000..53682ab74 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md @@ -0,0 +1,57 @@ +# Interface: ConversationsKickArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user + +```ts +user: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L119) diff --git a/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md new file mode 100644 index 000000000..fb4510563 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md @@ -0,0 +1,45 @@ +# Interface: ConversationsLeaveArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md b/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md new file mode 100644 index 000000000..b856f5f27 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md @@ -0,0 +1,65 @@ +# Interface: ConversationsMarkArguments + +## Extends + +- `Message`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Message.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ts + +```ts +ts: string; +``` + +#### Description + +Unique identifier of message. + +#### Inherited from + +`Message.ts` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md b/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md new file mode 100644 index 000000000..b3e6fa2cd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md @@ -0,0 +1,92 @@ +# Interface: ConversationsMembersArguments + +## Extends + +- `Channel`.`TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md b/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md new file mode 100644 index 000000000..da841a7e8 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md @@ -0,0 +1,61 @@ +# Interface: ConversationsRenameArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +New name for conversation. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L165) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md b/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md new file mode 100644 index 000000000..29c9c1890 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md @@ -0,0 +1,193 @@ +# Interface: ConversationsRepliesArguments + +## Extends + +- `Message`.`IncludeAllMetadata`.`TokenOverridable`.`CursorPaginationEnabled`.`TimelinePaginationEnabled` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Message.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### include\_all\_metadata? + +```ts +optional include_all_metadata: boolean; +``` + +#### Description + +Return all metadata associated with messages. Defaults to `false`. + +#### Inherited from + +`IncludeAllMetadata.include_all_metadata` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L27) + +*** + +### inclusive? + +```ts +optional inclusive: boolean; +``` + +#### Description + +Include messages with `oldest` or `latest` timestamps in results. +Ignored unless either timestamp is specified. Defaults to `false`. + +#### Inherited from + +`TimelinePaginationEnabled.inclusive` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L28) + +*** + +### latest? + +```ts +optional latest: string; +``` + +#### Description + +Only messages before this Unix timestamp will be included in results. + +#### Inherited from + +`TimelinePaginationEnabled.latest` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L23) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### oldest? + +```ts +optional oldest: string; +``` + +#### Description + +Only messages after this Unix timestamp will be included in results. + +#### Inherited from + +`TimelinePaginationEnabled.oldest` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L21) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ts + +```ts +ts: string; +``` + +#### Description + +Unique identifier of message. + +#### Inherited from + +`Message.ts` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/ConversationsSelect.md b/docs/content/reference/web-api/interfaces/ConversationsSelect.md new file mode 100644 index 000000000..0b11255f2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsSelect.md @@ -0,0 +1,206 @@ +# Interface: ConversationsSelect + +## Description + +This select menu will populate its options with a list of public and private channels, DMs, and MPIMs +visible to the current user in the active workspace. + +## See + + - [Select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversations_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### default\_to\_current\_conversation? + +```ts +optional default_to_current_conversation: boolean; +``` + +#### Description + +Pre-populates the select menu with the conversation that the user was viewing when they opened the +modal, if available. Default is `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:301 + +*** + +### filter? + +```ts +optional filter: object; +``` + +#### exclude\_bot\_users? + +```ts +optional exclude_bot_users: boolean; +``` + +#### exclude\_external\_shared\_channels? + +```ts +optional exclude_external_shared_channels: boolean; +``` + +#### include? + +```ts +optional include: ("im" | "mpim" | "private" | "public")[]; +``` + +#### Description + +A filter object that reduces the list of available conversations using the specified criteria. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:305 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_conversation? + +```ts +optional initial_conversation: string; +``` + +#### Description + +The ID of any valid conversation to be pre-selected when the menu loads. If +`default_to_current_conversation` is also supplied, `initial_conversation` will take precedence. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:289 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### response\_url\_enabled? + +```ts +optional response_url_enabled: boolean; +``` + +#### Description + +When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) +from the menu's parent view will contain a `response_url`. This `response_url` can be used for +[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation +for the message will be determined by the value of this select menu. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:296 + +*** + +### type + +```ts +type: "conversations_select"; +``` + +#### Description + +The type of element. In this case `type` is always `conversations_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:284 diff --git a/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md b/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md new file mode 100644 index 000000000..89b225f45 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md @@ -0,0 +1,61 @@ +# Interface: ConversationsSetPurposeArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### purpose + +```ts +purpose: string; +``` + +#### Description + +A new, specialer purpose. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:175](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L175) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md b/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md new file mode 100644 index 000000000..9c52f719b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md @@ -0,0 +1,61 @@ +# Interface: ConversationsSetTopicArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### topic + +```ts +topic: string; +``` + +#### Description + +The new topic string. Does not support formatting or linkification. + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L181) diff --git a/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md new file mode 100644 index 000000000..3eb9789e2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md @@ -0,0 +1,45 @@ +# Interface: ConversationsUnarchiveArguments + +## Extends + +- `Channel`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +ID of conversation. + +#### Inherited from + +`Channel.channel` + +#### Defined in + +[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/DateTimepicker.md b/docs/content/reference/web-api/interfaces/DateTimepicker.md new file mode 100644 index 000000000..237349021 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DateTimepicker.md @@ -0,0 +1,118 @@ +# Interface: DateTimepicker + +## Description + +Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop +clients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown +calendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date +picker will use native UIs. + +## See + + - [Datetime picker element reference](https://api.slack.com/reference/block-kit/block-elements#datetimepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_date\_time? + +```ts +optional initial_date_time: number; +``` + +#### Description + +The initial date and time that is selected when the element is loaded, represented as a UNIX +timestamp in seconds. This should be in the format of 10 digits, for example `1628633820` represents the date and +time August 10th, 2021 at 03:17pm PST. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:99 + +*** + +### type + +```ts +type: "datetimepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `datetimepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:93 diff --git a/docs/content/reference/web-api/interfaces/Datepicker.md b/docs/content/reference/web-api/interfaces/Datepicker.md new file mode 100644 index 000000000..d038f8b92 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Datepicker.md @@ -0,0 +1,135 @@ +# Interface: Datepicker + +## Description + +Allows users to select a date from a calendar style UI. + +## See + + - [Date picker element reference](https://api.slack.com/reference/block-kit/block-elements#datepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_date? + +```ts +optional initial_date: string; +``` + +#### Description + +The initial date that is selected when the element is loaded. +This should be in the format `YYYY-MM-DD`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:79 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "datepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `datepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:74 diff --git a/docs/content/reference/web-api/interfaces/Dialog.md b/docs/content/reference/web-api/interfaces/Dialog.md new file mode 100644 index 000000000..59b959d3c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Dialog.md @@ -0,0 +1,79 @@ +# Interface: ~~Dialog~~ + +Reusable shapes for argument values + +## Deprecated + +Dialogs are a deprecated surface in Slack. For more details on how to upgrade, check out our [Upgrading outmoded dialogs to modals guide](https://api.slack.com/block-kit/dialogs-to-modals). This will be removed in the next major version. + +## Properties + +### ~~callback\_id~~ + +```ts +callback_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:7 + +*** + +### ~~elements~~ + +```ts +elements: object[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:8 + +*** + +### ~~notify\_on\_cancel?~~ + +```ts +optional notify_on_cancel: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:29 + +*** + +### ~~state?~~ + +```ts +optional state: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:30 + +*** + +### ~~submit\_label?~~ + +```ts +optional submit_label: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:28 + +*** + +### ~~title~~ + +```ts +title: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/DialogOpenArguments.md b/docs/content/reference/web-api/interfaces/DialogOpenArguments.md new file mode 100644 index 000000000..7d971437c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DialogOpenArguments.md @@ -0,0 +1,57 @@ +# Interface: DialogOpenArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### dialog + +```ts +dialog: Dialog; +``` + +#### Description + +The dialog definition. + +#### Defined in + +[packages/web-api/src/types/request/dialog.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dialog.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +#### Description + +Exchange a trigger to post to the user. + +#### Defined in + +[packages/web-api/src/types/request/dialog.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dialog.ts#L7) diff --git a/docs/content/reference/web-api/interfaces/DispatchActionConfig.md b/docs/content/reference/web-api/interfaces/DispatchActionConfig.md new file mode 100644 index 000000000..5ab3966ca --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DispatchActionConfig.md @@ -0,0 +1,30 @@ +# Interface: DispatchActionConfig + +## Description + +Defines when a [PlainTextElement](PlainTextElement.md) will return a [`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +## See + +[`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +## Properties + +### trigger\_actions\_on? + +```ts +optional trigger_actions_on: ("on_enter_pressed" | "on_character_entered")[]; +``` + +#### Description + +An array of interaction types that you would like to receive a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions) for. Should be +one or both of: + `on_enter_pressed` — payload is dispatched when user presses the enter key while the input is in focus. Hint + text will appear underneath the input explaining to the user to press enter to submit. + `on_character_entered` — payload is dispatched when a character is entered (or removed) in the input. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:54 diff --git a/docs/content/reference/web-api/interfaces/Dispatchable.md b/docs/content/reference/web-api/interfaces/Dispatchable.md new file mode 100644 index 000000000..7cec6ccb0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Dispatchable.md @@ -0,0 +1,26 @@ +# Interface: Dispatchable + +## Extended by + +- [`EmailInput`](EmailInput.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 diff --git a/docs/content/reference/web-api/interfaces/DividerBlock.md b/docs/content/reference/web-api/interfaces/DividerBlock.md new file mode 100644 index 000000000..cb8b19461 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DividerBlock.md @@ -0,0 +1,58 @@ +# Interface: DividerBlock + +## Description + +Visually separates pieces of info inside of a message. A content divider, like an `
`, to split up +different blocks inside of a message. The divider block is nice and neat, requiring only a `type`. + +## See + +[Divider block reference](https://api.slack.com/reference/block-kit/blocks#divider). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### type + +```ts +type: "divider"; +``` + +#### Description + +The type of block. For a divider block, `type` is always `divider`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:55 diff --git a/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md b/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md new file mode 100644 index 000000000..dd2bac43d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md @@ -0,0 +1,41 @@ +# Interface: DndSetSnoozeArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### num\_minutes + +```ts +num_minutes: number; +``` + +#### Description + +Number of minutes, from now, to snooze until. + +#### Defined in + +[packages/web-api/src/types/request/dnd.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L16) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md b/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md new file mode 100644 index 000000000..aee528846 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md @@ -0,0 +1,61 @@ +# Interface: DndTeamInfoArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users + +```ts +users: string; +``` + +#### Description + +Comma-separated list of users to fetch Do Not Disturb status for. + +#### Defined in + +[packages/web-api/src/types/request/dnd.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L21) diff --git a/docs/content/reference/web-api/interfaces/EmailInput.md b/docs/content/reference/web-api/interfaces/EmailInput.md new file mode 100644 index 000000000..520c3a2dd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/EmailInput.md @@ -0,0 +1,134 @@ +# Interface: EmailInput + +## Description + +Allows user to enter an email into a single-line field. + +## See + + - [Email input element reference](https://api.slack.com/reference/block-kit/block-elements#email). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the email input when it is loaded. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:114 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "email_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `email_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:110 diff --git a/docs/content/reference/web-api/interfaces/ExternalSelect.md b/docs/content/reference/web-api/interfaces/ExternalSelect.md new file mode 100644 index 000000000..956f04a8a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ExternalSelect.md @@ -0,0 +1,153 @@ +# Interface: ExternalSelect + +## Description + +This select menu will load its options from an external data source, allowing for a dynamic list of +options. + +## See + + - [Select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_option? + +```ts +optional initial_option: PlainTextOption; +``` + +#### Description + +A single option to be selected when the menu initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:402 + +*** + +### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### Description + +When the typeahead field is used, a request will be sent on every character change. If you prefer +fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number +of typed characters required before dispatch. The default value is `3`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:408 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "external_select"; +``` + +#### Description + +The type of element. In this case `type` is always `external_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:398 diff --git a/docs/content/reference/web-api/interfaces/FileBlock.md b/docs/content/reference/web-api/interfaces/FileBlock.md new file mode 100644 index 000000000..5845ba358 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FileBlock.md @@ -0,0 +1,92 @@ +# Interface: FileBlock + +## Description + +Displays a [remote file](https://api.slack.com/messaging/files/remote). You can't add this block to +app surfaces directly, but it will show up when [retrieving messages](https://api.slack.com/messaging/retrieving) +that contain remote files. If you want to add remote files to messages, +[follow our guide](https://api.slack.com/messaging/files/remote). + +## See + +[File block reference](https://api.slack.com/reference/block-kit/blocks#file). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### external\_id + +```ts +external_id: string; +``` + +#### Description + +The external unique ID for this file. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:76 + +*** + +### source + +```ts +source: string; +``` + +#### Description + +At the moment, source will always be `remote` for a remote file. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:72 + +*** + +### type + +```ts +type: "file"; +``` + +#### Description + +The type of block. For a file block, `type` is always `file`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:68 diff --git a/docs/content/reference/web-api/interfaces/FileInput.md b/docs/content/reference/web-api/interfaces/FileInput.md new file mode 100644 index 000000000..733c19c3c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FileInput.md @@ -0,0 +1,89 @@ +# Interface: FileInput + +## Description + +Allows user to upload files. In order to use the `file_input` element within your app, +your app must have the `files:read` scope. + +## See + +[File input element reference](https://api.slack.com/reference/block-kit/block-elements#file_input). + +## Extends + +- [`Actionable`](Actionable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### filetypes? + +```ts +optional filetypes: string[]; +``` + +#### Description + +An array of valid [file extensions](https://api.slack.com/types/file#types) that will be accepted +for this element. All file extensions will be accepted if `filetypes` is not specified. This validation is provided +for convenience only, and you should perform your own file type validation based on what you expect to receive. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:131 + +*** + +### max\_files? + +```ts +optional max_files: number; +``` + +#### Description + +Maximum number of files that can be uploaded for this `file_input` element. Minimum of `1`, maximum of +`10`. Defaults to `10` if not specified. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:136 + +*** + +### type + +```ts +type: "file_input"; +``` + +#### Description + +The type of element. In this case `type` is always `file_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:125 diff --git a/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md b/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md new file mode 100644 index 000000000..81bb3f5f2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md @@ -0,0 +1,61 @@ +# Interface: FilesCommentsDeleteArguments + +## Extends + +- `FileArgument`.`TokenOverridable` + +## Properties + +### file + +```ts +file: string; +``` + +#### Description + +Encoded file ID. + +#### Inherited from + +`FileArgument.file` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) + +*** + +### id + +```ts +id: string; +``` + +#### Description + +The ID of the comment to delete. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:174](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L174) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md b/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md new file mode 100644 index 000000000..663595568 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md @@ -0,0 +1,45 @@ +# Interface: FilesDeleteArguments + +## Extends + +- `FileArgument`.`TokenOverridable` + +## Properties + +### file + +```ts +file: string; +``` + +#### Description + +Encoded file ID. + +#### Inherited from + +`FileArgument.file` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md b/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md new file mode 100644 index 000000000..c429befbd --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md @@ -0,0 +1,89 @@ +# Interface: FilesGetUploadURLExternalArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### alt\_text? + +```ts +optional alt_text: string; +``` + +#### Description + +Description of image for screen-reader. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L82) + +*** + +### filename + +```ts +filename: string; +``` + +#### Description + +Name of the file being uploaded. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L78) + +*** + +### length + +```ts +length: number; +``` + +#### Description + +Size in bytes of the file being uploaded. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L80) + +*** + +### snippet\_type? + +```ts +optional snippet_type: string; +``` + +#### Description + +Syntax type of the snippet being uploaded. E.g. `python`. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L84) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesInfoArguments.md b/docs/content/reference/web-api/interfaces/FilesInfoArguments.md new file mode 100644 index 000000000..b114b30d3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesInfoArguments.md @@ -0,0 +1,132 @@ +# Interface: FilesInfoArguments + +## Extends + +- `FileArgument`.`TokenOverridable`.`CursorPaginationEnabled`.`TraditionalPagingEnabled` + +## Properties + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### file + +```ts +file: string; +``` + +#### Description + +Encoded file ID. + +#### Inherited from + +`FileArgument.file` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesListArguments.md b/docs/content/reference/web-api/interfaces/FilesListArguments.md new file mode 100644 index 000000000..77c97d7d9 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesListArguments.md @@ -0,0 +1,184 @@ +# Interface: FilesListArguments + +## Extends + +- `TokenOverridable`.`TraditionalPagingEnabled`.`OptionalTeamAssignable` + +## Properties + +### channel? + +```ts +optional channel: string; +``` + +#### Description + +Filter files appearing in a specific channel, indicated by its ID. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L92) + +*** + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### show\_files\_hidden\_by\_limit? + +```ts +optional show_files_hidden_by_limit: boolean; +``` + +#### Description + +Show truncated file info for files hidden due to being too old, and the team who owns the file +being over the file limit. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L97) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ts\_from? + +```ts +optional ts_from: string; +``` + +#### Description + +Filter files created after this timestamp (inclusive). + +#### Defined in + +[packages/web-api/src/types/request/files.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L99) + +*** + +### ts\_to? + +```ts +optional ts_to: string; +``` + +#### Description + +Filter files created before this timestamp (inclusive). + +#### Defined in + +[packages/web-api/src/types/request/files.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L101) + +*** + +### types? + +```ts +optional types: string; +``` + +#### Description + +Filter files by type. Pass multiple values for `types` argument by comma-seperating the values. +The default value is `all`, which does not filter the list. +Available types are `all`, `spaces`, `snippets`, `images`, `gdocs`, `zips` and `pdfs`. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L107) + +*** + +### user? + +```ts +optional user: string; +``` + +#### Description + +Filter files created by a single user. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L109) diff --git a/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md b/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md new file mode 100644 index 000000000..9a7c66e5b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md @@ -0,0 +1,150 @@ +# Interface: FilesRemoteAddArguments + +## Extends + +- `SharedFile`.`FileType`.`ExternalIDArgument`.`TokenOverridable` + +## Properties + +### external\_id + +```ts +external_id: string; +``` + +#### Description + +Creator defined GUID for the file. + +#### Inherited from + +`ExternalIDArgument.external_id` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L17) + +*** + +### external\_url + +```ts +external_url: string; +``` + +#### Description + +URL of the remote file. + +#### Inherited from + +`SharedFile.external_url` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L180) + +*** + +### filetype? + +```ts +optional filetype: string; +``` + +#### Description + +A file type identifier. + +#### See + +[File types](https://api.slack.com/types/file#file_types) for a complete list of supported file types. + +#### Inherited from + +`FileType.filetype` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L31) + +*** + +### indexable\_file\_contents? + +```ts +optional indexable_file_contents: Buffer | Stream; +``` + +#### Description + +A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery +of the remote file. + +#### Inherited from + +`SharedFile.indexable_file_contents` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L187) + +*** + +### preview\_image? + +```ts +optional preview_image: Buffer | Stream; +``` + +#### Description + +Preview of the document. + +#### Inherited from + +`SharedFile.preview_image` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L182) + +*** + +### title + +```ts +title: string; +``` + +#### Description + +Title of the file being shared. + +#### Inherited from + +`SharedFile.title` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:178](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L178) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md b/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md new file mode 100644 index 000000000..864e1ca12 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md @@ -0,0 +1,120 @@ +# Interface: FilesRemoteListArguments + +## Extends + +- `TokenOverridable`.`CursorPaginationEnabled` + +## Properties + +### channel? + +```ts +optional channel: string; +``` + +#### Description + +Filter files appearing in a specific channel, indicated by its ID. + +#### Defined in + +[packages/web-api/src/types/request/files.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L199) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ts\_from? + +```ts +optional ts_from: string; +``` + +#### Description + +Filter files created after this timestamp (inclusive). + +#### Defined in + +[packages/web-api/src/types/request/files.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L201) + +*** + +### ts\_to? + +```ts +optional ts_to: string; +``` + +#### Description + +Filter files created before this timestamp (inclusive). + +#### Defined in + +[packages/web-api/src/types/request/files.ts:203](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L203) diff --git a/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md b/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md new file mode 100644 index 000000000..920f0d9f8 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md @@ -0,0 +1,45 @@ +# Interface: FilesRevokePublicURLArguments + +## Extends + +- `FileArgument`.`TokenOverridable` + +## Properties + +### file + +```ts +file: string; +``` + +#### Description + +Encoded file ID. + +#### Inherited from + +`FileArgument.file` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md b/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md new file mode 100644 index 000000000..f046347d7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md @@ -0,0 +1,45 @@ +# Interface: FilesSharedPublicURLArguments + +## Extends + +- `FileArgument`.`TokenOverridable` + +## Properties + +### file + +```ts +file: string; +``` + +#### Description + +Encoded file ID. + +#### Inherited from + +`FileArgument.file` + +#### Defined in + +[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Focusable.md b/docs/content/reference/web-api/interfaces/Focusable.md new file mode 100644 index 000000000..6685356d6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Focusable.md @@ -0,0 +1,42 @@ +# Interface: Focusable + +## Extended by + +- [`Checkboxes`](Checkboxes.md) +- [`Datepicker`](Datepicker.md) +- [`DateTimepicker`](DateTimepicker.md) +- [`EmailInput`](EmailInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`RadioButtons`](RadioButtons.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 diff --git a/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md b/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md new file mode 100644 index 000000000..13c9c1642 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md @@ -0,0 +1,53 @@ +# Interface: FunctionsCompleteErrorArguments + +## Extends + +- `ExecutionID`.`TokenOverridable` + +## Properties + +### error + +```ts +error: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/functions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L9) + +*** + +### function\_execution\_id + +```ts +function_execution_id: string; +``` + +#### Inherited from + +`ExecutionID.function_execution_id` + +#### Defined in + +[packages/web-api/src/types/request/functions.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L4) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md b/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md new file mode 100644 index 000000000..6e994ef36 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md @@ -0,0 +1,53 @@ +# Interface: FunctionsCompleteSuccessArguments + +## Extends + +- `ExecutionID`.`TokenOverridable` + +## Properties + +### function\_execution\_id + +```ts +function_execution_id: string; +``` + +#### Inherited from + +`ExecutionID.function_execution_id` + +#### Defined in + +[packages/web-api/src/types/request/functions.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L4) + +*** + +### outputs + +```ts +outputs: Record; +``` + +#### Defined in + +[packages/web-api/src/types/request/functions.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/HeaderBlock.md b/docs/content/reference/web-api/interfaces/HeaderBlock.md new file mode 100644 index 000000000..ab761661a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/HeaderBlock.md @@ -0,0 +1,75 @@ +# Interface: HeaderBlock + +## Description + +Displays a larger-sized text block. A `header` is a plain-text block that displays in a larger, bold +font. Use it to delineate between different groups of content in your app's surfaces. + +## See + +[Header block reference](https://api.slack.com/reference/block-kit/blocks#header). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +The text for the block, in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 150 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:92 + +*** + +### type + +```ts +type: "header"; +``` + +#### Description + +The type of block. For a header block, `type` is always `header`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:87 diff --git a/docs/content/reference/web-api/interfaces/HomeView.md b/docs/content/reference/web-api/interfaces/HomeView.md new file mode 100644 index 000000000..6dcc9b93b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/HomeView.md @@ -0,0 +1,61 @@ +# Interface: HomeView + +## Properties + +### blocks + +```ts +blocks: (Block | KnownBlock)[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:5 + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:7 + +*** + +### external\_id? + +```ts +optional external_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:8 + +*** + +### private\_metadata? + +```ts +optional private_metadata: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:6 + +*** + +### type + +```ts +type: "home"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:4 diff --git a/docs/content/reference/web-api/interfaces/InputBlock.md b/docs/content/reference/web-api/interfaces/InputBlock.md new file mode 100644 index 000000000..938ef5a89 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/InputBlock.md @@ -0,0 +1,156 @@ +# Interface: InputBlock + +## Description + +Collects information from users via block elements. + +## See + + - [Input block reference](https://api.slack.com/reference/block-kit/blocks#input). + - [Collecting input in modals guide](https://api.slack.com/surfaces/modals#gathering_input). + - [Collecting input in Home tabs guide](https://api.slack.com/surfaces/app-home#gathering_input). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### dispatch\_action? + +```ts +optional dispatch_action: boolean; +``` + +#### Description + +A boolean that indicates whether or not the use of elements in this block should dispatch a +[block_actions payload](https://api.slack.com/reference/interaction-payloads/block-actions). Defaults to `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:148 + +*** + +### element + +```ts +element: + | Checkboxes + | Datepicker + | DateTimepicker + | MultiSelect + | RadioButtons + | Select + | Timepicker + | RichTextInput + | PlainTextInput + | URLInput + | EmailInput + | NumberInput + | FileInput; +``` + +#### Description + +A block element. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:143 + +*** + +### hint? + +```ts +optional hint: PlainTextElement; +``` + +#### Description + +An optional hint that appears below an input element in a lighter grey. It must be a +[object](PlainTextElement.md). Maximum length for the `text` in this field is 2000 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:134 + +*** + +### label + +```ts +label: PlainTextElement; +``` + +#### Description + +A label that appears above an input element in the form of a [PlainTextElement](PlainTextElement.md) object. +Maximum length for the text in this field is 2000 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:129 + +*** + +### optional? + +```ts +optional optional: boolean; +``` + +#### Description + +A boolean that indicates whether the input element may be empty when a user submits the modal. +Defaults to `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:139 + +*** + +### type + +```ts +type: "input"; +``` + +#### Description + +The type of block. For an input block, `type` is always `input`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:124 diff --git a/docs/content/reference/web-api/interfaces/LinkUnfurls.md b/docs/content/reference/web-api/interfaces/LinkUnfurls.md new file mode 100644 index 000000000..d041ae784 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/LinkUnfurls.md @@ -0,0 +1,5 @@ +# Interface: LinkUnfurls + +## Indexable + + \[`linkUrl`: `string`\]: [`MessageAttachment`](MessageAttachment.md) diff --git a/docs/content/reference/web-api/interfaces/Logger.md b/docs/content/reference/web-api/interfaces/Logger.md new file mode 100644 index 000000000..56561ef1e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Logger.md @@ -0,0 +1,167 @@ +# Interface: Logger + +Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). + +## Methods + +### debug() + +```ts +debug(...msg): void +``` + +Output debug message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:18 + +*** + +### error() + +```ts +error(...msg): void +``` + +Output error message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:33 + +*** + +### getLevel() + +```ts +getLevel(): LogLevel +``` + +Return the current LogLevel. + +#### Returns + +[`LogLevel`](../enumerations/LogLevel.md) + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:43 + +*** + +### info() + +```ts +info(...msg): void +``` + +Output info message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:23 + +*** + +### setLevel() + +```ts +setLevel(level): void +``` + +This disables all logging below the given level, so that after a log.setLevel("warn") call log.warn("something") +or log.error("something") will output messages, but log.info("something") will not. + +#### Parameters + +• **level**: [`LogLevel`](../enumerations/LogLevel.md) + +as a string, like 'error' (case-insensitive) + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:39 + +*** + +### setName() + +```ts +setName(name): void +``` + +This allows the instance to be named so that they can easily be filtered when many loggers are sending output +to the same destination. + +#### Parameters + +• **name**: `string` + +as a string, will be output with every log after the level + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:49 + +*** + +### warn() + +```ts +warn(...msg): void +``` + +Output warn message + +#### Parameters + +• ...**msg**: `any`[] + +any data to log + +#### Returns + +`void` + +#### Defined in + +packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:28 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachment.md b/docs/content/reference/web-api/interfaces/MessageAttachment.md new file mode 100644 index 000000000..de071da3f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MessageAttachment.md @@ -0,0 +1,401 @@ +# Interface: MessageAttachment + +Add [secondary attachments](https://api.slack.com/messaging/composing/layouts#attachments) to your messages in Slack. +Message attachments are considered a legacy part of messaging functionality. They are not deprecated per se, but they may change in the future, in ways that reduce their visibility or utility. We recommend moving to Block Kit instead. Read more about [when to use message attachments](https://api.slack.com/messaging/composing/layouts#when-to-use-attachments). + +## See + +[Secondary message attachments reference documentation](https://api.slack.com/reference/messaging/attachments) + +## Properties + +### actions? + +```ts +optional actions: AttachmentAction[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:97 + +*** + +### app\_id? + +```ts +optional app_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:107 + +*** + +### app\_unfurl\_url? + +```ts +optional app_unfurl_url: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:105 + +*** + +### author\_icon? + +```ts +optional author_icon: string; +``` + +#### Description + +A valid URL that displays a small 16px by 16px image to the left of the `author_name` text. +Will only work if `author_name` is present. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:41 + +*** + +### author\_link? + +```ts +optional author_link: string; +``` + +#### Description + +A valid URL that will hyperlink the `author_name` text. Will only work if `author_name` is present. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:36 + +*** + +### author\_name? + +```ts +optional author_name: string; +``` + +#### Description + +Small text used to display the author's name. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:32 + +*** + +### author\_subname? + +```ts +optional author_subname: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:42 + +*** + +### blocks? + +```ts +optional blocks: (Block | KnownBlock)[]; +``` + +#### Description + +An array of [layout blocks](../type-aliases/KnownBlock.md) in the same format +[as described in the building blocks guide](https://api.slack.com/block-kit/building). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:13 + +*** + +### bot\_id? + +```ts +optional bot_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:108 + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:98 + +*** + +### color? + +```ts +optional color: string; +``` + +#### Description + +Changes the color of the border on the left side of this attachment from the default gray. Can either +be one of `good` (green), `warning` (yellow), `danger` (red), or any hex color code (eg. `#439FE0`) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:23 + +*** + +### fallback? + +```ts +optional fallback: string; +``` + +#### Description + +A plain text summary of the attachment used in clients that +don't show formatted text (e.g. mobile notifications). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:18 + +*** + +### fields? + +```ts +optional fields: MessageAttachmentField[]; +``` + +#### Description + +An array of [MessageAttachmentField](MessageAttachmentField.md) that get displayed in a table-like way +(see [this example](https://api.slack.com/reference/messaging/attachments#example)). +For best results, include no more than 2-3 field objects. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:63 + +*** + +### footer? + +```ts +optional footer: string; +``` + +#### Description + +Some brief text to help contextualize and identify an attachment. Limited to 300 characters, +and may be truncated further when displayed to users in environments with limited screen real estate. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:83 + +*** + +### footer\_icon? + +```ts +optional footer_icon: string; +``` + +#### Description + +A valid URL to an image file that will be displayed beside the `footer` text. +Will only work if `footer` is present. We'll render what you provide at 16px by 16px. +It's best to use an image that is similarly sized. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:89 + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +#### Description + +A valid URL to an image file that will be displayed at the bottom of the attachment. +We support GIF, JPEG, PNG, and BMP formats. +Large images will be resized to a maximum width of 360px or a maximum height of 500px, while still +maintaining the original aspect ratio. Cannot be used with `thumb_url`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:70 + +*** + +### is\_app\_unfurl? + +```ts +optional is_app_unfurl: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:106 + +*** + +### mrkdwn\_in? + +```ts +optional mrkdwn_in: ("text" | "pretext" | "fields")[]; +``` + +#### Description + +Field names that should be [formatted by `mrkdwn` syntax](https://api.slack.com/reference/surfaces/formatting#basics). +The fields that can be formatted in this way include the names of the `fields` property, or +the `text` or `pretext` properties. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:104 + +*** + +### pretext? + +```ts +optional pretext: string; +``` + +#### Description + +Text that appears above the message attachment block. It can be formatted as plain text, +or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:28 + +*** + +### preview? + +```ts +optional preview: MessageAttachmentPreview; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:109 + +*** + +### text? + +```ts +optional text: string; +``` + +#### Description + +The main body text of the attachment. It can be formatted as plain text, or with +[`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. +The content will automatically collapse if it contains 700+ characters or 5+ line breaks, and will display +a "Show more..." link to expand the content. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:57 + +*** + +### thumb\_url? + +```ts +optional thumb_url: string; +``` + +#### Description + +A valid URL to an image file that will be displayed as a thumbnail on the right side of +a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. +The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. +The file size of the image must also be less than 500 KB. +For best results, please use images that are already 75px by 75px. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:78 + +*** + +### title? + +```ts +optional title: string; +``` + +#### Description + +Large title text near the top of the attachment. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:46 + +*** + +### title\_link? + +```ts +optional title_link: string; +``` + +#### Description + +A valid URL that turns the `title` text into a hyperlink. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:50 + +*** + +### ts? + +```ts +optional ts: string; +``` + +#### Description + +A Unix timestamp that is used to relate your attachment to a specific time. +The attachment will display the additional timestamp value as part of the attachment's footer. +Your message's timestamp will be displayed in varying ways, depending on how far in the past or future it is, +relative to the present. Form factors, like mobile versus desktop may also transform its rendered appearance. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:96 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachmentField.md b/docs/content/reference/web-api/interfaces/MessageAttachmentField.md new file mode 100644 index 000000000..1d41c5d92 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MessageAttachmentField.md @@ -0,0 +1,59 @@ +# Interface: MessageAttachmentField + +## Description + +A field object to include in a [MessageAttachment](MessageAttachment.md). + +## See + +[Field objects reference](https://api.slack.com/reference/messaging/attachments#field_objects). + +## Properties + +### short? + +```ts +optional short: boolean; +``` + +#### Description + +Indicates whether the field object is short enough to be displayed side-by-side with +other field objects. Defaults to `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:129 + +*** + +### title + +```ts +title: string; +``` + +#### Description + +Shown as a bold heading displayed in the field object. It cannot contain markup and +will be escaped for you. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:120 + +*** + +### value + +```ts +value: string; +``` + +#### Description + +The text value displayed in the field object. It can be formatted as plain text, or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by using the `mrkdwn_in` option of [MessageAttachment](MessageAttachment.md). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:124 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md b/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md new file mode 100644 index 000000000..8ad0de0e3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md @@ -0,0 +1,61 @@ +# Interface: MessageAttachmentPreview + +## Properties + +### can\_remove? + +```ts +optional can_remove: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:133 + +*** + +### iconUrl? + +```ts +optional iconUrl: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:136 + +*** + +### subtitle? + +```ts +optional subtitle: PlainTextElement; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:135 + +*** + +### title? + +```ts +optional title: PlainTextElement; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:134 + +*** + +### type? + +```ts +optional type: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:132 diff --git a/docs/content/reference/web-api/interfaces/MessageMetadata.md b/docs/content/reference/web-api/interfaces/MessageMetadata.md new file mode 100644 index 000000000..90f964628 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MessageMetadata.md @@ -0,0 +1,52 @@ +# Interface: MessageMetadata + +## Description + +Application-specific data to attach to Slack message. + +## See + + - [Using Metadata](https://api.slack.com/metadata/using) + - [Metadata Payload Structure](https://api.slack.com/reference/metadata#payload_structure) + +## Properties + +### event\_payload + +```ts +event_payload: object; +``` + +#### Index Signature + + \[`key`: `string`\]: + \| `string` + \| `number` + \| `boolean` + \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md) + \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md)[] + +#### Description + +A free-form object containing whatever data your application wishes to attach to messages. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:15 + +*** + +### event\_type + +```ts +event_type: string; +``` + +#### Description + +A human readable alphanumeric string representing your application's metadata event. +The value of this field may appear in the UI to developers. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:11 diff --git a/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md b/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md new file mode 100644 index 000000000..fa6b94c30 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md @@ -0,0 +1,5 @@ +# Interface: MessageMetadataEventPayloadObject + +## Indexable + + \[`key`: `string`\]: `string` \| `number` \| `boolean` diff --git a/docs/content/reference/web-api/interfaces/Method.md b/docs/content/reference/web-api/interfaces/Method.md new file mode 100644 index 000000000..cf220a52f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Method.md @@ -0,0 +1,27 @@ +# Interface: Method()\ + +Generic method definition + +## Type Parameters + +• **MethodArguments** + +• **MethodResult** *extends* [`WebAPICallResult`](WebAPICallResult.md) = [`WebAPICallResult`](WebAPICallResult.md) + +```ts +interface Method(options): Promise +``` + +Generic method definition + +## Parameters + +• **options**: `MethodArguments` + +## Returns + +`Promise`\<`MethodResult`\> + +## Defined in + +[packages/web-api/src/methods.ts:508](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L508) diff --git a/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md b/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md new file mode 100644 index 000000000..43a2c6813 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md @@ -0,0 +1,77 @@ +# Interface: MigrationExchangeArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### to\_old? + +```ts +optional to_old: boolean; +``` + +#### Description + +Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/migration.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/migration.ts#L8) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### users + +```ts +users: string; +``` + +#### Description + +A comma-separated list of user IDs, up to 400 per request. + +#### Defined in + +[packages/web-api/src/types/request/migration.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/migration.ts#L6) diff --git a/docs/content/reference/web-api/interfaces/ModalView.md b/docs/content/reference/web-api/interfaces/ModalView.md new file mode 100644 index 000000000..68b8c6eb2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ModalView.md @@ -0,0 +1,121 @@ +# Interface: ModalView + +## Properties + +### blocks + +```ts +blocks: (Block | KnownBlock)[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:13 + +*** + +### callback\_id? + +```ts +optional callback_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:17 + +*** + +### clear\_on\_close? + +```ts +optional clear_on_close: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:18 + +*** + +### close? + +```ts +optional close: PlainTextElement; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:14 + +*** + +### external\_id? + +```ts +optional external_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:20 + +*** + +### notify\_on\_close? + +```ts +optional notify_on_close: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:19 + +*** + +### private\_metadata? + +```ts +optional private_metadata: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:16 + +*** + +### submit? + +```ts +optional submit: PlainTextElement; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:15 + +*** + +### title + +```ts +title: PlainTextElement; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:12 + +*** + +### type + +```ts +type: "modal"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:11 diff --git a/docs/content/reference/web-api/interfaces/MrkdwnElement.md b/docs/content/reference/web-api/interfaces/MrkdwnElement.md new file mode 100644 index 000000000..3ac7cf980 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MrkdwnElement.md @@ -0,0 +1,61 @@ +# Interface: MrkdwnElement + +## Description + +Defines an object containing some text. + +## See + +[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). + +## Properties + +### text + +```ts +text: string; +``` + +#### Description + +The text for the block. This field accepts any of the standard text formatting markup. +The minimum length is 1 and maximum length is 3000 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:139 + +*** + +### type + +```ts +type: "mrkdwn"; +``` + +#### Description + +The formatting to use for this text object. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:134 + +*** + +### verbatim? + +```ts +optional verbatim: boolean; +``` + +#### Description + +When set to `false` (as is default) URLs will be auto-converted into links, conversation names will +be link-ified, and certain mentions will be [automatically parsed](https://api.slack.com/reference/surfaces/formatting#automatic-parsing). +Using a value of `true` will skip any preprocessing of this nature, although you can still include +[manual parsing strings](https://api.slack.com/reference/surfaces/formatting#advanced). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:146 diff --git a/docs/content/reference/web-api/interfaces/MrkdwnOption.md b/docs/content/reference/web-api/interfaces/MrkdwnOption.md new file mode 100644 index 000000000..8e31c1f32 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MrkdwnOption.md @@ -0,0 +1,85 @@ +# Interface: MrkdwnOption + +## Extends + +- `OptionDescriptor` + +## Properties + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. +Maximum length for the `text` within this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.description` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:71 + +*** + +### text + +```ts +text: MrkdwnElement; +``` + +#### Description + +A [MrkdwnElement](MrkdwnElement.md) that defines the text shown in the option on the menu. To be used with +radio buttons and checkboxes. Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:78 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +Only available in overflow menus! A URL to load in the user's browser when the option is clicked. +Maximum length for this field is 3000 characters. + +#### Inherited from + +`OptionDescriptor.url` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:66 + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +A unique string value that will be passed to your app when this option is chosen. +Maximum length for this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.value` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:61 diff --git a/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md b/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md new file mode 100644 index 000000000..e94a03d13 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md @@ -0,0 +1,151 @@ +# Interface: MultiChannelsSelect + +## Description + +This multi-select menu will populate its options with a list of public channels visible to the current +user in the active workspace. + +## See + + - [Multi-select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channel_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_channels? + +```ts +optional initial_channels: string[]; +``` + +#### Description + +An array of one or more IDs of any valid public channel to be pre-selected when the menu loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:382 + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:386 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "multi_channels_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_channels_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:378 diff --git a/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md b/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md new file mode 100644 index 000000000..65d4b8554 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md @@ -0,0 +1,203 @@ +# Interface: MultiConversationsSelect + +## Description + +This multi-select menu will populate its options with a list of public and private channels, DMs, and +MPIMs visible to the current user in the active workspace. + +## See + + - [Multi-select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### default\_to\_current\_conversation? + +```ts +optional default_to_current_conversation: boolean; +``` + +#### Description + +Pre-populates the select menu with the conversation that the user was viewing when they opened the +modal, if available. Default is `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:335 + +*** + +### filter? + +```ts +optional filter: object; +``` + +#### exclude\_bot\_users? + +```ts +optional exclude_bot_users: boolean; +``` + +#### exclude\_external\_shared\_channels? + +```ts +optional exclude_external_shared_channels: boolean; +``` + +#### include? + +```ts +optional include: ("im" | "mpim" | "private" | "public")[]; +``` + +#### Description + +A filter object that reduces the list of available conversations using the specified criteria. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:339 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_conversations? + +```ts +optional initial_conversations: string[]; +``` + +#### Description + +An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If +`default_to_current_conversation` is also supplied, `initial_conversation` will be ignored. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:326 + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:330 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "multi_conversations_select"; +``` + +#### Description + +The type of element. In this case `type` is always `conversations_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:321 diff --git a/docs/content/reference/web-api/interfaces/MultiExternalSelect.md b/docs/content/reference/web-api/interfaces/MultiExternalSelect.md new file mode 100644 index 000000000..c4fa9f0aa --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MultiExternalSelect.md @@ -0,0 +1,168 @@ +# Interface: MultiExternalSelect + +## Description + +This menu will load its options from an external data source, allowing for a dynamic list of options. + +## See + + - [Multi-select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_options? + +```ts +optional initial_options: PlainTextOption[]; +``` + +#### Description + +An array of options to be selected when the menu initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:423 + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:433 + +*** + +### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### Description + +When the typeahead field is used, a request will be sent on every character change. If you prefer +fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number +of typed characters required before dispatch. The default value is `3`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:429 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "multi_external_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_external_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:419 diff --git a/docs/content/reference/web-api/interfaces/MultiStaticSelect.md b/docs/content/reference/web-api/interfaces/MultiStaticSelect.md new file mode 100644 index 000000000..91dbd608d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MultiStaticSelect.md @@ -0,0 +1,186 @@ +# Interface: MultiStaticSelect + +## Description + +This is the simplest form of select menu, with a static list of options passed in when defining the +element. + +## See + + - [Multi-select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_options? + +```ts +optional initial_options: PlainTextOption[]; +``` + +#### Description + +An array of option objects that exactly match one or more of the options within `options` or +`option_groups`. These options will be selected when the menu initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:255 + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:272 + +*** + +### option\_groups? + +```ts +optional option_groups: object[]; +``` + +#### Description + +An array of option group objects. Maximum number of option groups is 100. If `options` is specified, +this field should not be. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:265 + +*** + +### options? + +```ts +optional options: PlainTextOption[]; +``` + +#### Description + +An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is +specified, this field should not be. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:260 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "multi_static_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_static_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:250 diff --git a/docs/content/reference/web-api/interfaces/MultiUsersSelect.md b/docs/content/reference/web-api/interfaces/MultiUsersSelect.md new file mode 100644 index 000000000..a1e4dce9d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/MultiUsersSelect.md @@ -0,0 +1,151 @@ +# Interface: MultiUsersSelect + +## Description + +This multi-select menu will populate its options with a list of Slack users visible to the current user +in the active workspace. + +## See + + - [Multi-select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_users? + +```ts +optional initial_users: string[]; +``` + +#### Description + +An array of user IDs of any valid users to be pre-selected when the menu loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:204 + +*** + +### max\_selected\_items? + +```ts +optional max_selected_items: number; +``` + +#### Description + +Specifies the maximum number of items that can be selected in the menu. Minimum number is `1`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:208 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "multi_users_select"; +``` + +#### Description + +The type of element. In this case `type` is always `multi_users_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:200 diff --git a/docs/content/reference/web-api/interfaces/NumberInput.md b/docs/content/reference/web-api/interfaces/NumberInput.md new file mode 100644 index 000000000..9e0decede --- /dev/null +++ b/docs/content/reference/web-api/interfaces/NumberInput.md @@ -0,0 +1,184 @@ +# Interface: NumberInput + +## Description + +Allows user to enter a number into a single-line field. The number input element accepts both whole and +decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Decimal numbers are only allowed when +`is_decimal_allowed` is equal to `true`. + +## See + + - [Number input element reference](https://api.slack.com/reference/block-kit/block-elements#number). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the input when it is loaded. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:454 + +*** + +### is\_decimal\_allowed + +```ts +is_decimal_allowed: boolean; +``` + +#### Description + +Decimal numbers are allowed if this property is `true`, set the value to `false` otherwise. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:450 + +*** + +### max\_value? + +```ts +optional max_value: string; +``` + +#### Description + +The maximum value, cannot be less than `min_value`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:462 + +*** + +### min\_value? + +```ts +optional min_value: string; +``` + +#### Description + +The minimum value, cannot be greater than `max_value`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:458 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "number_input"; +``` + +#### Description + +The type of element. In this case `type` is always `number_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:446 diff --git a/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md b/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md new file mode 100644 index 000000000..ef5c6cfa0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md @@ -0,0 +1,102 @@ +# Interface: OAuthAccessArguments + +## Extends + +- `OAuthCredentials` + +## Properties + +### client\_id + +```ts +client_id: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) + +*** + +### client\_secret + +```ts +client_secret: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_secret` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) + +*** + +### code? + +```ts +optional code: string; +``` + +#### Description + +The `code` parameter returned via the OAuth callback. + +#### Inherited from + +`OAuthCredentials.code` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) + +*** + +### redirect\_uri? + +```ts +optional redirect_uri: string; +``` + +#### Description + +While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's +first step and must match the originally submitted URI. + +#### Inherited from + +`OAuthCredentials.redirect_uri` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) + +*** + +### single\_channel? + +```ts +optional single_channel: boolean; +``` + +#### Description + +Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps). Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/oauth.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/oauth.ts#L6) diff --git a/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md b/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md new file mode 100644 index 000000000..63dc416d6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md @@ -0,0 +1,126 @@ +# Interface: OAuthV2AccessArguments + +## Extends + +- `OAuthCredentials`.`OAuthGrantRefresh` + +## Properties + +### client\_id + +```ts +client_id: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) + +*** + +### client\_secret + +```ts +client_secret: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_secret` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) + +*** + +### code? + +```ts +optional code: string; +``` + +#### Description + +The `code` parameter returned via the OAuth callback. + +#### Inherited from + +`OAuthCredentials.code` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) + +*** + +### grant\_type? + +```ts +optional grant_type: "authorization_code" | "refresh_token"; +``` + +#### Description + +The `grant_type` param as described in the OAuth spec. + +#### Inherited from + +`OAuthGrantRefresh.grant_type` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L139) + +*** + +### redirect\_uri? + +```ts +optional redirect_uri: string; +``` + +#### Description + +While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's +first step and must match the originally submitted URI. + +#### Inherited from + +`OAuthCredentials.redirect_uri` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) + +*** + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +#### Description + +The `refresh_token` param as described in the OAuth spec. + +#### Inherited from + +`OAuthGrantRefresh.refresh_token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L141) diff --git a/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md b/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md new file mode 100644 index 000000000..5daaa1cfe --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md @@ -0,0 +1,61 @@ +# Interface: OAuthV2ExchangeArguments + +## Extends + +- `Pick`\<`OAuthCredentials`, `"client_id"` \| `"client_secret"`\> + +## Properties + +### client\_id + +```ts +client_id: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`Pick.client_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) + +*** + +### client\_secret + +```ts +client_secret: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`Pick.client_secret` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) + +*** + +### token + +```ts +token: string; +``` + +#### Description + +The legacy xoxb or xoxp token being migrated. + +#### Defined in + +[packages/web-api/src/types/request/oauth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/oauth.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md b/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md new file mode 100644 index 000000000..95f450563 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md @@ -0,0 +1,126 @@ +# Interface: OpenIDConnectTokenArguments + +## Extends + +- `OAuthCredentials`.`OAuthGrantRefresh` + +## Properties + +### client\_id + +```ts +client_id: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) + +*** + +### client\_secret + +```ts +client_secret: string; +``` + +#### Description + +Issued when you created your application. + +#### Inherited from + +`OAuthCredentials.client_secret` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) + +*** + +### code? + +```ts +optional code: string; +``` + +#### Description + +The `code` parameter returned via the OAuth callback. + +#### Inherited from + +`OAuthCredentials.code` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) + +*** + +### grant\_type? + +```ts +optional grant_type: "authorization_code" | "refresh_token"; +``` + +#### Description + +The `grant_type` param as described in the OAuth spec. + +#### Inherited from + +`OAuthGrantRefresh.grant_type` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L139) + +*** + +### redirect\_uri? + +```ts +optional redirect_uri: string; +``` + +#### Description + +While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's +first step and must match the originally submitted URI. + +#### Inherited from + +`OAuthCredentials.redirect_uri` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) + +*** + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +#### Description + +The `refresh_token` param as described in the OAuth spec. + +#### Inherited from + +`OAuthGrantRefresh.refresh_token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L141) diff --git a/docs/content/reference/web-api/interfaces/OptionField.md b/docs/content/reference/web-api/interfaces/OptionField.md new file mode 100644 index 000000000..2a999bc90 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OptionField.md @@ -0,0 +1,37 @@ +# Interface: OptionField + +## Properties + +### description? + +```ts +optional description: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:157 + +*** + +### text + +```ts +text: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:158 + +*** + +### value + +```ts +value: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:159 diff --git a/docs/content/reference/web-api/interfaces/OptionGroup.md b/docs/content/reference/web-api/interfaces/OptionGroup.md new file mode 100644 index 000000000..0721bcf07 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/OptionGroup.md @@ -0,0 +1,42 @@ +# Interface: OptionGroup + +## Description + +Defines a way to group options in a select or multi-select menu. + +## See + +[Option group object reference](https://api.slack.com/reference/block-kit/composition-objects#option_group). + +## Properties + +### label + +```ts +label: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) text object that defines the label shown above this group of options. +Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:102 + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) that belong to this specific group. Maximum of 100 items. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:106 diff --git a/docs/content/reference/web-api/interfaces/Overflow.md b/docs/content/reference/web-api/interfaces/Overflow.md new file mode 100644 index 000000000..df71a2c7b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Overflow.md @@ -0,0 +1,95 @@ +# Interface: Overflow + +## Description + +Allows users to press a button to view a list of options. +Unlike the select menu, there is no typeahead field, and the button always appears with an ellipsis ('…') rather +than customizable text. As such, it is usually used if you want a more compact layout than a select menu, or to +supply a list of less visually important actions after a row of buttons. You can also specify simple URL links as +overflow menu options, instead of actions. + +## See + + - [Overflow menu element reference](https://api.slack.com/reference/block-kit/block-elements#overflow). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### options + +```ts +options: PlainTextOption[]; +``` + +#### Description + +An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:481 + +*** + +### type + +```ts +type: "overflow"; +``` + +#### Description + +The type of element. In this case `type` is always `number_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:477 diff --git a/docs/content/reference/web-api/interfaces/PageReducer.md b/docs/content/reference/web-api/interfaces/PageReducer.md new file mode 100644 index 000000000..5ba4e6c30 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PageReducer.md @@ -0,0 +1,28 @@ +# Interface: PageReducer()\ + +## Type Parameters + +• **A** = `any` + +```ts +interface PageReducer( + accumulator, + page, + index): A +``` + +## Parameters + +• **accumulator**: `undefined` \| `A` + +• **page**: [`WebAPICallResult`](WebAPICallResult.md) + +• **index**: `number` + +## Returns + +`A` + +## Defined in + +[packages/web-api/src/WebClient.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L114) diff --git a/docs/content/reference/web-api/interfaces/PaginatePredicate.md b/docs/content/reference/web-api/interfaces/PaginatePredicate.md new file mode 100644 index 000000000..c7ba6a2d0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PaginatePredicate.md @@ -0,0 +1,17 @@ +# Interface: PaginatePredicate() + +```ts +interface PaginatePredicate(page): undefined | boolean | void +``` + +## Parameters + +• **page**: [`WebAPICallResult`](WebAPICallResult.md) + +## Returns + +`undefined` \| `boolean` \| `void` + +## Defined in + +[packages/web-api/src/WebClient.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L109) diff --git a/docs/content/reference/web-api/interfaces/PinsAddArguments.md b/docs/content/reference/web-api/interfaces/PinsAddArguments.md new file mode 100644 index 000000000..2e12c567b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PinsAddArguments.md @@ -0,0 +1,65 @@ +# Interface: PinsAddArguments + +## Extends + +- `MessageArgument`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel where the message was posted. + +#### Inherited from + +`MessageArgument.channel` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) + +*** + +### timestamp + +```ts +timestamp: string; +``` + +#### Description + +Timestamp of the message. + +#### Inherited from + +`MessageArgument.timestamp` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/PinsListArguments.md b/docs/content/reference/web-api/interfaces/PinsListArguments.md new file mode 100644 index 000000000..18505b1ad --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PinsListArguments.md @@ -0,0 +1,41 @@ +# Interface: PinsListArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel to get pinned items for. + +#### Defined in + +[packages/web-api/src/types/request/pins.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/pins.ts#L8) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md b/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md new file mode 100644 index 000000000..1fbd4fcfc --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md @@ -0,0 +1,65 @@ +# Interface: PinsRemoveArguments + +## Extends + +- `MessageArgument`.`TokenOverridable` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel where the message was posted. + +#### Inherited from + +`MessageArgument.channel` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) + +*** + +### timestamp + +```ts +timestamp: string; +``` + +#### Description + +Timestamp of the message. + +#### Inherited from + +`MessageArgument.timestamp` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Placeholdable.md b/docs/content/reference/web-api/interfaces/Placeholdable.md new file mode 100644 index 000000000..811bc19d4 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Placeholdable.md @@ -0,0 +1,38 @@ +# Interface: Placeholdable + +## Extended by + +- [`Datepicker`](Datepicker.md) +- [`EmailInput`](EmailInput.md) +- [`UsersSelect`](UsersSelect.md) +- [`MultiUsersSelect`](MultiUsersSelect.md) +- [`StaticSelect`](StaticSelect.md) +- [`MultiStaticSelect`](MultiStaticSelect.md) +- [`ConversationsSelect`](ConversationsSelect.md) +- [`MultiConversationsSelect`](MultiConversationsSelect.md) +- [`ChannelsSelect`](ChannelsSelect.md) +- [`MultiChannelsSelect`](MultiChannelsSelect.md) +- [`ExternalSelect`](ExternalSelect.md) +- [`MultiExternalSelect`](MultiExternalSelect.md) +- [`NumberInput`](NumberInput.md) +- [`PlainTextInput`](PlainTextInput.md) +- [`Timepicker`](Timepicker.md) +- [`URLInput`](URLInput.md) +- [`RichTextInput`](RichTextInput.md) + +## Properties + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 diff --git a/docs/content/reference/web-api/interfaces/PlainTextElement.md b/docs/content/reference/web-api/interfaces/PlainTextElement.md new file mode 100644 index 000000000..0bdc0c0ad --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PlainTextElement.md @@ -0,0 +1,57 @@ +# Interface: PlainTextElement + +## Description + +Defines an object containing some text. + +## See + +[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). + +## Properties + +### emoji? + +```ts +optional emoji: boolean; +``` + +#### Description + +Indicates whether emojis in a text field should be escaped into the colon emoji format. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:124 + +*** + +### text + +```ts +text: string; +``` + +#### Description + +The text for the block. The minimum length is 1 and maximum length is 3000 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:120 + +*** + +### type + +```ts +type: "plain_text"; +``` + +#### Description + +The formatting to use for this text object. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:116 diff --git a/docs/content/reference/web-api/interfaces/PlainTextInput.md b/docs/content/reference/web-api/interfaces/PlainTextInput.md new file mode 100644 index 000000000..c0b270a40 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PlainTextInput.md @@ -0,0 +1,185 @@ +# Interface: PlainTextInput + +## Description + +Allows users to enter freeform text data into a single-line or multi-line field. + +## See + + - [Plain-text input element reference](https://api.slack.com/reference/block-kit/block-elements#input). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the plain-text input when it is loaded. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:496 + +*** + +### max\_length? + +```ts +optional max_length: number; +``` + +#### Description + +The maximum length of input that the user can provide. If the user provides more, +they will receive an error. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:511 + +*** + +### min\_length? + +```ts +optional min_length: number; +``` + +#### Description + +The minimum length of input that the user must provide. If the user provides less, they will receive +an error. Maximum value is 3000. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:506 + +*** + +### multiline? + +```ts +optional multiline: boolean; +``` + +#### Description + +Indicates whether the input will be a single line (`false`) or a larger textarea (`true`). +Defaults to `false`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:501 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "plain_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `plain_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:492 diff --git a/docs/content/reference/web-api/interfaces/PlainTextOption.md b/docs/content/reference/web-api/interfaces/PlainTextOption.md new file mode 100644 index 000000000..119fb95e6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/PlainTextOption.md @@ -0,0 +1,85 @@ +# Interface: PlainTextOption + +## Extends + +- `OptionDescriptor` + +## Properties + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. +Maximum length for the `text` within this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.description` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:71 + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the text shown in the option on the menu. To be used with +overflow, select and multi-select menus. Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:85 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +Only available in overflow menus! A URL to load in the user's browser when the option is clicked. +Maximum length for this field is 3000 characters. + +#### Inherited from + +`OptionDescriptor.url` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:66 + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +A unique string value that will be passed to your app when this option is chosen. +Maximum length for this field is 75 characters. + +#### Inherited from + +`OptionDescriptor.value` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:61 diff --git a/docs/content/reference/web-api/interfaces/RadioButtons.md b/docs/content/reference/web-api/interfaces/RadioButtons.md new file mode 100644 index 000000000..f3d634c07 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RadioButtons.md @@ -0,0 +1,130 @@ +# Interface: RadioButtons + +## Description + +Allows users to choose one item from a list of possible options. + +## See + + - [Radio button group element reference](https://api.slack.com/reference/block-kit/block-elements#radio). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_option? + +```ts +optional initial_option: Option; +``` + +#### Description + +An [Option](../type-aliases/Option.md) object that exactly matches one of the options within `options`. This option will +be selected when the radio button group initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:527 + +*** + +### options + +```ts +options: Option[]; +``` + +#### Description + +An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:531 + +*** + +### type + +```ts +type: "radio_buttons"; +``` + +#### Description + +The type of element. In this case `type` is always `radio_buttons`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:522 diff --git a/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md b/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md new file mode 100644 index 000000000..e622d4dd3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md @@ -0,0 +1,85 @@ +# Interface: ReactionsAddArguments + +## Extends + +- `MessageArgument`.`TokenOverridable`.`ReactionName` + +## Properties + +### channel + +```ts +channel: string; +``` + +#### Description + +Channel where the message was posted. + +#### Inherited from + +`MessageArgument.channel` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +Reaction (emoji) name. + +#### Inherited from + +`ReactionName.name` + +#### Defined in + +[packages/web-api/src/types/request/reactions.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L18) + +*** + +### timestamp + +```ts +timestamp: string; +``` + +#### Description + +Timestamp of the message. + +#### Inherited from + +`MessageArgument.timestamp` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersAddArguments.md b/docs/content/reference/web-api/interfaces/RemindersAddArguments.md new file mode 100644 index 000000000..8da4220e7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RemindersAddArguments.md @@ -0,0 +1,119 @@ +# Interface: RemindersAddArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### recurrence? + +```ts +optional recurrence: ReminderRecurrence; +``` + +#### Description + +Specify the repeating behavior of a reminder. If you set the sub-property `frequency` to `weekly`, +you must also set the `weekdays` array to specify which days of the week to recur on. + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L37) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### text + +```ts +text: string; +``` + +#### Description + +The content of the reminder. + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L19) + +*** + +### time + +```ts +time: string | number; +``` + +#### Description + +When this reminder should happen, one of: +- the Unix timestamp (up to five years from now), +- the number of seconds until the reminder (if within 24 hours), or +- a natural language description (Ex. "in 15 minutes," or "every Thursday"). + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L26) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### ~~user?~~ + +```ts +optional user: string; +``` + +#### Description + +No longer supported - reminders cannot be set for other users. + +#### Deprecated + +#### See + +[Changes to `reminders.*` APIs announcement](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders#what). + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L32) diff --git a/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md b/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md new file mode 100644 index 000000000..da2d0b0e6 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md @@ -0,0 +1,61 @@ +# Interface: RemindersCompleteArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### reminder + +```ts +reminder: string; +``` + +#### Description + +The ID of the reminder to be marked as complete. + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L42) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md b/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md new file mode 100644 index 000000000..d59ce5e0b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md @@ -0,0 +1,61 @@ +# Interface: RemindersDeleteArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### reminder + +```ts +reminder: string; +``` + +#### Description + +The ID of the reminder to delete. + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L47) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md b/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md new file mode 100644 index 000000000..e14c66f63 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md @@ -0,0 +1,61 @@ +# Interface: RemindersInfoArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### reminder + +```ts +reminder: string; +``` + +#### Description + +The ID of the reminder to retrieve information about. + +#### Defined in + +[packages/web-api/src/types/request/reminders.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L52) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RetryOptions.md b/docs/content/reference/web-api/interfaces/RetryOptions.md new file mode 100644 index 000000000..5c0d07a4c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RetryOptions.md @@ -0,0 +1,199 @@ +# Interface: RetryOptions + +Options to create retry policies. Extends from https://github.com/tim-kos/node-retry. + +## Extends + +- `OperationOptions` + +## Properties + +### factor? + +```ts +optional factor: number; +``` + +The exponential factor to use. + +#### Default + +```ts +2 +``` + +#### Inherited from + +`OperationOptions.factor` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:125 + +*** + +### forever? + +```ts +optional forever: boolean; +``` + +Whether to retry forever. + +#### Default + +```ts +false +``` + +#### Inherited from + +`OperationOptions.forever` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:88 + +*** + +### maxRetryTime? + +```ts +optional maxRetryTime: number; +``` + +The maximum time (in milliseconds) that the retried operation is allowed to run. + +#### Default + +```ts +Infinity +``` + +#### Inherited from + +`OperationOptions.maxRetryTime` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:98 + +*** + +### maxTimeout? + +```ts +optional maxTimeout: number; +``` + +The maximum number of milliseconds between two retries. + +#### Default + +```ts +Infinity +``` + +#### Inherited from + +`OperationOptions.maxTimeout` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:135 + +*** + +### minTimeout? + +```ts +optional minTimeout: number; +``` + +The number of milliseconds before starting the first retry. + +#### Default + +```ts +1000 +``` + +#### Inherited from + +`OperationOptions.minTimeout` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:130 + +*** + +### randomize? + +```ts +optional randomize: boolean; +``` + +Randomizes the timeouts by multiplying a factor between 1-2. + +#### Default + +```ts +false +``` + +#### Inherited from + +`OperationOptions.randomize` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:140 + +*** + +### retries? + +```ts +optional retries: number; +``` + +The maximum amount of times to retry the operation. + +#### Default + +```ts +10 +``` + +#### Inherited from + +`OperationOptions.retries` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:109 + +*** + +### unref? + +```ts +optional unref: boolean; +``` + +Whether to [unref](https://nodejs.org/api/timers.html#timers_unref) the setTimeout's. + +#### Default + +```ts +false +``` + +#### Inherited from + +`OperationOptions.unref` + +#### Defined in + +packages/web-api/node\_modules/@types/retry/index.d.ts:93 diff --git a/docs/content/reference/web-api/interfaces/RichTextBlock.md b/docs/content/reference/web-api/interfaces/RichTextBlock.md new file mode 100644 index 000000000..b275bff97 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextBlock.md @@ -0,0 +1,61 @@ +# Interface: RichTextBlock + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### elements + +```ts +elements: (RichTextSection | RichTextList | RichTextQuote | RichTextPreformatted)[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:235 + +*** + +### type + +```ts +type: "rich_text"; +``` + +#### Description + +The type of block. For a rich text block, `type` is always `rich_text`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:234 diff --git a/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md b/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md new file mode 100644 index 000000000..f347ba9c7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextBroadcastMention + +## Description + +A broadcast mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### range + +```ts +range: "channel" | "here" | "everyone"; +``` + +#### Description + +The range of the broadcast; can be one of `here`, `channel` and `everyone`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:643 + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "broadcast"; +``` + +#### Description + +The type of element. In this case `type` is always `broadcast`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:639 diff --git a/docs/content/reference/web-api/interfaces/RichTextChannelMention.md b/docs/content/reference/web-api/interfaces/RichTextChannelMention.md new file mode 100644 index 000000000..f5e6483e7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextChannelMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextChannelMention + +## Description + +A channel mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### channel\_id + +```ts +channel_id: string; +``` + +#### Description + +The encoded channel ID, e.g. C1234ABCD. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:669 + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "channel"; +``` + +#### Description + +The type of element. In this case `type` is always `channel`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:665 diff --git a/docs/content/reference/web-api/interfaces/RichTextColor.md b/docs/content/reference/web-api/interfaces/RichTextColor.md new file mode 100644 index 000000000..cb933f86e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextColor.md @@ -0,0 +1,101 @@ +# Interface: RichTextColor + +## Description + +A hex color element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "color"; +``` + +#### Description + +The type of element. In this case `type` is always `color`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:652 + +*** + +### value + +```ts +value: string; +``` + +#### Description + +The hex value for the color. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:656 diff --git a/docs/content/reference/web-api/interfaces/RichTextDate.md b/docs/content/reference/web-api/interfaces/RichTextDate.md new file mode 100644 index 000000000..dc59e8e18 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextDate.md @@ -0,0 +1,169 @@ +# Interface: RichTextDate + +## Description + +A date element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### fallback? + +```ts +optional fallback: string; +``` + +#### Description + +Text to display in place of the date should parsing, formatting or displaying fails. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:714 + +*** + +### format + +```ts +format: string; +``` + +#### Description + +A template string containing curly-brace-enclosed tokens to substitute your provided `timestamp` +in a particularly-formatted way. For example: `Posted at {date_long}`. The available date formatting tokens are: +- `{day_divider_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable. Otherwise, if the date is in + current year, uses the `{date_long}` format without the year. Otherwise, falls back to using the `{date_long}` + format. +- `{date_num}`: Shows date as YYYY-MM-DD. +- `{date_slash}`: Shows date as DD/MM/YYYY (subject to locale preferences). +- `{date_long}`: Shows date as a long-form sentence including day-of-week, e.g. `Monday, December 23rd, 2013`. +- `{date_long_full}`: Shows date as a long-form sentence without day-of-week, e.g. `August 9, 2020`. +- `{date_long_pretty}`: Shows `yesterday`, `today` or `tomorrow`, otherwise uses the `{date_long}` format. +- `{date}`: Same as `{date_long_full}` but without the year. +- `{date_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date}` format. +- `{date_short}`: Shows date using short month names without day-of-week, e.g. `Aug 9, 2020`. +- `{date_short_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date_short}` + format. +- `{time}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 or + 24 hour clock formats, e.g. `2:34 PM` or `14:34`. +- `{time_secs}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 + or 24 hour clock formats, including seconds, e.g. `2:34:56 PM` or `14:34:56`. +- `{ago}`: A human-readable period of time, e.g. `3 minutes ago`, `4 hours ago`, `2 days ago`. +TODO: test/document `{member_local_time}`, `{status_expiration}` and `{calendar_header}` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:706 + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### timestamp + +```ts +timestamp: number; +``` + +#### Description + +A UNIX timestamp for the date to be displayed in seconds. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:682 + +*** + +### type + +```ts +type: "date"; +``` + +#### Description + +The type of element. In this case `type` is always `date`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:678 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +URL to link the entire `format` string to. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:710 diff --git a/docs/content/reference/web-api/interfaces/RichTextEmoji.md b/docs/content/reference/web-api/interfaces/RichTextEmoji.md new file mode 100644 index 000000000..f609fc0e1 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextEmoji.md @@ -0,0 +1,133 @@ +# Interface: RichTextEmoji + +## Description + +An emoji element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### name + +```ts +name: string; +``` + +#### Description + +Name of emoji, without colons or skin tones, e.g. `wave` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:727 + +*** + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "emoji"; +``` + +#### Description + +The type of element. In this case `type` is always `emoji`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:723 + +*** + +### unicode? + +```ts +optional unicode: string; +``` + +#### Description + +Lowercase hexadecimal Unicode representation of a standard emoji (not for use with custom emoji). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:731 + +*** + +### url? + +```ts +optional url: string; +``` + +#### Description + +URL of emoji asset. Only used when sharing custom emoji across workspaces. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:735 diff --git a/docs/content/reference/web-api/interfaces/RichTextInput.md b/docs/content/reference/web-api/interfaces/RichTextInput.md new file mode 100644 index 000000000..ad3e7c70e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextInput.md @@ -0,0 +1,135 @@ +# Interface: RichTextInput + +## Description + +A rich text input creates a composer/WYSIWYG editor for entering formatted text, offering nearly the +same experience you have writing messages in Slack. + +## See + + - [Rich-text input element reference](https://api.slack.com/reference/block-kit/block-elements#rich_text_input). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_value? + +```ts +optional initial_value: RichTextBlock; +``` + +#### Description + +Initial contents of the input when it is loaded. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:902 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "rich_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:898 diff --git a/docs/content/reference/web-api/interfaces/RichTextLink.md b/docs/content/reference/web-api/interfaces/RichTextLink.md new file mode 100644 index 000000000..92691364d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextLink.md @@ -0,0 +1,133 @@ +# Interface: RichTextLink + +## Description + +A link element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### text? + +```ts +optional text: string; +``` + +#### Description + +The text to link. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:748 + +*** + +### type + +```ts +type: "link"; +``` + +#### Description + +The type of element. In this case `type` is always `link`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:744 + +*** + +### unsafe? + +```ts +optional unsafe: boolean; +``` + +#### Description + +TODO: ? + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:752 + +*** + +### url + +```ts +url: string; +``` + +#### Description + +URL to link to. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:756 diff --git a/docs/content/reference/web-api/interfaces/RichTextList.md b/docs/content/reference/web-api/interfaces/RichTextList.md new file mode 100644 index 000000000..6042be75c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextList.md @@ -0,0 +1,88 @@ +# Interface: RichTextList + +## Description + +A list block within a rich text field. + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the list. `0` renders no border +while `1` renders a border. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:850 + +*** + +### elements + +```ts +elements: RichTextSection[]; +``` + +#### Description + +An array of [RichTextSection](RichTextSection.md) elements comprising each list item. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:835 + +*** + +### indent? + +```ts +optional indent: number; +``` + +#### Description + +The style of the list points. Can be a number from `0` (default) to `8`. Yields a different character +or characters rendered as the list points. Also affected by the `style` property. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:845 + +*** + +### style + +```ts +style: "bullet" | "ordered"; +``` + +#### Description + +The type of list. Can be either `bullet` (the list points are all rendered the same way) or `ordered` +(the list points increase numerically from 1). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:840 + +*** + +### type + +```ts +type: "rich_text_list"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_list`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:831 diff --git a/docs/content/reference/web-api/interfaces/RichTextPreformatted.md b/docs/content/reference/web-api/interfaces/RichTextPreformatted.md new file mode 100644 index 000000000..bf3e0ed4c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextPreformatted.md @@ -0,0 +1,54 @@ +# Interface: RichTextPreformatted + +## Description + +A block of preformatted text within a rich text field. + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the preformatted text. +`0` renders no border, while `1` renders a border. Defaults to `0`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:886 + +*** + +### elements + +```ts +elements: (RichTextLink | RichTextText)[]; +``` + +#### Description + +An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextText.md) comprising the preformatted text. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:881 + +*** + +### type + +```ts +type: "rich_text_preformatted"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_preformatted`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:877 diff --git a/docs/content/reference/web-api/interfaces/RichTextQuote.md b/docs/content/reference/web-api/interfaces/RichTextQuote.md new file mode 100644 index 000000000..1b3b40a54 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextQuote.md @@ -0,0 +1,54 @@ +# Interface: RichTextQuote + +## Description + +A quote block within a rich text field. + +## Properties + +### border? + +```ts +optional border: 0 | 1; +``` + +#### Description + +Whether to render a quote-block-like border on the inline side of the text quote. +`0` renders no border, while `1` renders a border. Defaults to `0`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:868 + +*** + +### elements + +```ts +elements: RichTextElement[]; +``` + +#### Description + +An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the quote block. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:863 + +*** + +### type + +```ts +type: "rich_text_quote"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_quote`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:859 diff --git a/docs/content/reference/web-api/interfaces/RichTextSection.md b/docs/content/reference/web-api/interfaces/RichTextSection.md new file mode 100644 index 000000000..f76a878bf --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextSection.md @@ -0,0 +1,33 @@ +# Interface: RichTextSection + +## Description + +A section block within a rich text field. + +## Properties + +### elements + +```ts +elements: RichTextElement[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:822 + +*** + +### type + +```ts +type: "rich_text_section"; +``` + +#### Description + +The type of element. In this case `type` is always `rich_text_section`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:821 diff --git a/docs/content/reference/web-api/interfaces/RichTextStyleable.md b/docs/content/reference/web-api/interfaces/RichTextStyleable.md new file mode 100644 index 000000000..2c32bbe6b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextStyleable.md @@ -0,0 +1,74 @@ +# Interface: RichTextStyleable + +## Description + +For use styling Rich Text sub-elements. + +## Extended by + +- [`RichTextBroadcastMention`](RichTextBroadcastMention.md) +- [`RichTextColor`](RichTextColor.md) +- [`RichTextChannelMention`](RichTextChannelMention.md) +- [`RichTextDate`](RichTextDate.md) +- [`RichTextEmoji`](RichTextEmoji.md) +- [`RichTextLink`](RichTextLink.md) +- [`RichTextTeamMention`](RichTextTeamMention.md) +- [`RichTextText`](RichTextText.md) +- [`RichTextUserMention`](RichTextUserMention.md) +- [`RichTextUsergroupMention`](RichTextUsergroupMention.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 diff --git a/docs/content/reference/web-api/interfaces/RichTextTeamMention.md b/docs/content/reference/web-api/interfaces/RichTextTeamMention.md new file mode 100644 index 000000000..824aa44e2 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextTeamMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextTeamMention + +## Description + +A workspace or team mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### team\_id + +```ts +team_id: string; +``` + +#### Description + +The encoded team ID, e.g. T1234ABCD. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:769 + +*** + +### type + +```ts +type: "team"; +``` + +#### Description + +The type of element. In this case `type` is always `team`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:765 diff --git a/docs/content/reference/web-api/interfaces/RichTextText.md b/docs/content/reference/web-api/interfaces/RichTextText.md new file mode 100644 index 000000000..189071a6c --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextText.md @@ -0,0 +1,101 @@ +# Interface: RichTextText + +## Description + +A generic text element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### text + +```ts +text: string; +``` + +#### Description + +The text to render. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:782 + +*** + +### type + +```ts +type: "text"; +``` + +#### Description + +The type of element. In this case `type` is always `text`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:778 diff --git a/docs/content/reference/web-api/interfaces/RichTextUserMention.md b/docs/content/reference/web-api/interfaces/RichTextUserMention.md new file mode 100644 index 000000000..1e519876e --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextUserMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextUserMention + +## Description + +A user mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "user"; +``` + +#### Description + +The type of element. In this case `type` is always `user`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:791 + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +The encoded user ID, e.g. U1234ABCD. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:795 diff --git a/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md b/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md new file mode 100644 index 000000000..800caf15d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md @@ -0,0 +1,101 @@ +# Interface: RichTextUsergroupMention + +## Description + +A usergroup mention element for use in a rich text message. + +## Extends + +- [`RichTextStyleable`](RichTextStyleable.md) + +## Properties + +### style? + +```ts +optional style: object; +``` + +#### bold? + +```ts +optional bold: boolean; +``` + +##### Description + +When `true`, boldens the text in this element. Defaults to `false`. + +#### code? + +```ts +optional code: boolean; +``` + +##### Description + +When `true`, the text is preformatted in an inline code style. Defaults to `false. + +#### italic? + +```ts +optional italic: boolean; +``` + +##### Description + +When `true`, italicizes the text in this element. Defaults to `false`. + +#### strike? + +```ts +optional strike: boolean; +``` + +##### Description + +When `true`, strikes through the text in this element. Defaults to `false`. + +#### Description + +A limited style object for styling rich text `text` elements. + +#### Inherited from + +[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 + +*** + +### type + +```ts +type: "usergroup"; +``` + +#### Description + +The type of element. In this case `type` is always `usergroup`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:804 + +*** + +### usergroup\_id + +```ts +usergroup_id: string; +``` + +#### Description + +The encoded usergroup ID, e.g. S1234ABCD. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:808 diff --git a/docs/content/reference/web-api/interfaces/SearchAllArguments.md b/docs/content/reference/web-api/interfaces/SearchAllArguments.md new file mode 100644 index 000000000..7dc54af58 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SearchAllArguments.md @@ -0,0 +1,169 @@ +# Interface: SearchAllArguments + +## Extends + +- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` + +## Properties + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### highlight? + +```ts +optional highlight: boolean; +``` + +#### Description + +Set to `true` to enable query highlight markers. Defaults to `false`. + +#### See + +[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. + +#### Inherited from + +`Searchable.highlight` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### query + +```ts +query: string; +``` + +#### Description + +Search query. + +#### Inherited from + +`Searchable.query` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) + +*** + +### sort? + +```ts +optional sort: "score" | "timestamp"; +``` + +#### Description + +Return matches sorted by either `score` or `timestamp`. Defaults to `score`. + +#### Inherited from + +`Searchable.sort` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) + +*** + +### sort\_dir? + +```ts +optional sort_dir: "asc" | "desc"; +``` + +#### Description + +Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. + +#### Inherited from + +`Searchable.sort_dir` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Searchable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SearchFilesArguments.md b/docs/content/reference/web-api/interfaces/SearchFilesArguments.md new file mode 100644 index 000000000..bbbc55080 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SearchFilesArguments.md @@ -0,0 +1,169 @@ +# Interface: SearchFilesArguments + +## Extends + +- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` + +## Properties + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### highlight? + +```ts +optional highlight: boolean; +``` + +#### Description + +Set to `true` to enable query highlight markers. Defaults to `false`. + +#### See + +[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. + +#### Inherited from + +`Searchable.highlight` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### query + +```ts +query: string; +``` + +#### Description + +Search query. + +#### Inherited from + +`Searchable.query` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) + +*** + +### sort? + +```ts +optional sort: "score" | "timestamp"; +``` + +#### Description + +Return matches sorted by either `score` or `timestamp`. Defaults to `score`. + +#### Inherited from + +`Searchable.sort` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) + +*** + +### sort\_dir? + +```ts +optional sort_dir: "asc" | "desc"; +``` + +#### Description + +Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. + +#### Inherited from + +`Searchable.sort_dir` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Searchable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md b/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md new file mode 100644 index 000000000..23901e796 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md @@ -0,0 +1,169 @@ +# Interface: SearchMessagesArguments + +## Extends + +- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` + +## Properties + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### highlight? + +```ts +optional highlight: boolean; +``` + +#### Description + +Set to `true` to enable query highlight markers. Defaults to `false`. + +#### See + +[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. + +#### Inherited from + +`Searchable.highlight` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### query + +```ts +query: string; +``` + +#### Description + +Search query. + +#### Inherited from + +`Searchable.query` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) + +*** + +### sort? + +```ts +optional sort: "score" | "timestamp"; +``` + +#### Description + +Return matches sorted by either `score` or `timestamp`. Defaults to `score`. + +#### Inherited from + +`Searchable.sort` + +#### Defined in + +[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) + +*** + +### sort\_dir? + +```ts +optional sort_dir: "asc" | "desc"; +``` + +#### Description + +Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. + +#### Inherited from + +`Searchable.sort_dir` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`Searchable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SectionBlock.md b/docs/content/reference/web-api/interfaces/SectionBlock.md new file mode 100644 index 000000000..dd8733c18 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SectionBlock.md @@ -0,0 +1,122 @@ +# Interface: SectionBlock + +## Description + +Displays text, possibly alongside block elements. A section can be used as a simple text block, in +combination with text fields, or side-by-side with certain +[block elements](https://api.slack.com/reference/messaging/block-elements). + +## See + +[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### accessory? + +```ts +optional accessory: + | Button + | Actionable + | Checkboxes + | Datepicker + | MultiSelect + | Overflow + | RadioButtons + | Select + | Timepicker + | ImageElement; +``` + +#### Description + +One of the compatible element objects. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:177 + +*** + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### fields? + +```ts +optional fields: (PlainTextElement | MrkdwnElement)[]; +``` + +#### Description + +Required if no `text` is provided. An array of text objects. Any text objects included with `fields` +will be rendered in a compact format that allows for 2 columns of side-by-side text. Maximum number of items is 10. +Maximum length for the text in each item is 2000 characters. +[Click here for an example](https://app.slack.com/block-kit-builder/#%7B%22blocks%22:%5B%7B%22type%22:%22section%22,%22text%22:%7B%22text%22:%22A%20message%20*with%20some%20bold%20text*%20and%20_some%20italicized%20text_.%22,%22type%22:%22mrkdwn%22%7D,%22fields%22:%5B%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Priority*%22%7D,%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Type*%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22High%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22String%22%7D%5D%7D%5D%7D). + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:173 + +*** + +### text? + +```ts +optional text: PlainTextElement | MrkdwnElement; +``` + +#### Description + +The text for the block, in the form of a text object. Minimum length for the `text` in this field is +1 and maximum length is 3000 characters. This field is not required if a valid array of `fields` objects is +provided instead. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:166 + +*** + +### type + +```ts +type: "section"; +``` + +#### Description + +The type of block. For a section block, `type` is always `section`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:160 diff --git a/docs/content/reference/web-api/interfaces/SelectOption.md b/docs/content/reference/web-api/interfaces/SelectOption.md new file mode 100644 index 000000000..8f174f015 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SelectOption.md @@ -0,0 +1,25 @@ +# Interface: SelectOption + +## Properties + +### label + +```ts +label: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:33 + +*** + +### value + +```ts +value: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:34 diff --git a/docs/content/reference/web-api/interfaces/SlackFileImageObject.md b/docs/content/reference/web-api/interfaces/SlackFileImageObject.md new file mode 100644 index 000000000..d83269def --- /dev/null +++ b/docs/content/reference/web-api/interfaces/SlackFileImageObject.md @@ -0,0 +1,21 @@ +# Interface: SlackFileImageObject + +## Description + +Object for image which contains a slack_file. + +## Properties + +### slack\_file + +```ts +slack_file: SlackFile; +``` + +#### Description + +The slack file of the image to be displayed. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:188 diff --git a/docs/content/reference/web-api/interfaces/StarsListArguments.md b/docs/content/reference/web-api/interfaces/StarsListArguments.md new file mode 100644 index 000000000..3bde10813 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/StarsListArguments.md @@ -0,0 +1,132 @@ +# Interface: StarsListArguments + +## Extends + +- `TokenOverridable`.`TraditionalPagingEnabled`.`CursorPaginationEnabled`.`OptionalTeamAssignable` + +## Properties + +### count? + +```ts +optional count: number; +``` + +#### Description + +Number of items to return per page. Defaults to `20` + +#### Inherited from + +`TraditionalPagingEnabled.count` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### page? + +```ts +optional page: number; +``` + +#### Description + +Page number of results to return. Defaults to `1`. + +#### Inherited from + +`TraditionalPagingEnabled.page` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/StaticSelect.md b/docs/content/reference/web-api/interfaces/StaticSelect.md new file mode 100644 index 000000000..279c9fafa --- /dev/null +++ b/docs/content/reference/web-api/interfaces/StaticSelect.md @@ -0,0 +1,170 @@ +# Interface: StaticSelect + +## Description + +This is the simplest form of select menu, with a static list of options passed in when defining the +element. + +## See + + - [Select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_option? + +```ts +optional initial_option: PlainTextOption; +``` + +#### Description + +A single option that exactly matches one of the options within `options` or `option_groups`. +This option will be selected when the menu initially loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:225 + +*** + +### option\_groups? + +```ts +optional option_groups: object[]; +``` + +#### Description + +An array of option group objects. Maximum number of option groups is 100. If `options` is specified, +this field should not be. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:235 + +*** + +### options? + +```ts +optional options: PlainTextOption[]; +``` + +#### Description + +An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is +specified, this field should not be. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:230 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "static_select"; +``` + +#### Description + +The type of element. In this case `type` is always `static_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:220 diff --git a/docs/content/reference/web-api/interfaces/Timepicker.md b/docs/content/reference/web-api/interfaces/Timepicker.md new file mode 100644 index 000000000..c3673383b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/Timepicker.md @@ -0,0 +1,155 @@ +# Interface: Timepicker + +## Description + +Allows users to choose a time from a rich dropdown UI. On desktop clients, this time picker will take +the form of a dropdown list with free-text entry for precise choices. On mobile clients, the time picker will use +native time picker UIs. + +## See + + - [Time picker element reference](https://api.slack.com/reference/block-kit/block-elements#timepicker). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_time? + +```ts +optional initial_time: string; +``` + +#### Description + +The initial time that is selected when the element is loaded. This should be in the format `HH:mm`, +where `HH` is the 24-hour format of an hour (00 to 23) and `mm` is minutes with leading zeros (00 to 59), +for example 22:25 for 10:25pm. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:550 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### timezone? + +```ts +optional timezone: string; +``` + +#### Description + +A string in the IANA format, e.g. 'America/Chicago'. The timezone is displayed to end users as hint +text underneath the time picker. It is also passed to the app upon certain interactions, such as view_submission. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:555 + +*** + +### type + +```ts +type: "timepicker"; +``` + +#### Description + +The type of element. In this case `type` is always `timepicker`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:544 diff --git a/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md b/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md new file mode 100644 index 000000000..9588d86cf --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md @@ -0,0 +1,17 @@ +# Interface: ToolingTokensRotateArguments + +## Properties + +### refresh\_token + +```ts +refresh_token: string; +``` + +#### Description + +The `xoxe` refresh token that was issued along with the old app configuration token. + +#### Defined in + +[packages/web-api/src/types/request/tooling.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/tooling.ts#L4) diff --git a/docs/content/reference/web-api/interfaces/URLInput.md b/docs/content/reference/web-api/interfaces/URLInput.md new file mode 100644 index 000000000..b9f2fc77a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/URLInput.md @@ -0,0 +1,134 @@ +# Interface: URLInput + +## Description + +Allows user to enter a URL into a single-line field. + +## See + + - [URL input element reference](https://api.slack.com/reference/block-kit/block-elements#url). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### dispatch\_action\_config? + +```ts +optional dispatch_action_config: DispatchActionConfig; +``` + +#### Description + +A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a +[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). + +#### Inherited from + +[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_value? + +```ts +optional initial_value: string; +``` + +#### Description + +The initial value in the URL input when it is loaded. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:570 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "url_text_input"; +``` + +#### Description + +The type of element. In this case `type` is always `url_text_input`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:566 diff --git a/docs/content/reference/web-api/interfaces/UrlImageObject.md b/docs/content/reference/web-api/interfaces/UrlImageObject.md new file mode 100644 index 000000000..5dfb148a0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UrlImageObject.md @@ -0,0 +1,21 @@ +# Interface: UrlImageObject + +## Description + +Object for image which contains a image_url. + +## Properties + +### image\_url + +```ts +image_url: string; +``` + +#### Description + +The URL of the image to be displayed. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:179 diff --git a/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md new file mode 100644 index 000000000..124ffe088 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md @@ -0,0 +1,129 @@ +# Interface: UsergroupsCreateArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` + +## Properties + +### channels? + +```ts +optional channels: string; +``` + +#### Description + +A comma separated string of encoded channel IDs for which the User Group uses as a default. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L14) + +*** + +### description? + +```ts +optional description: string; +``` + +#### Description + +A short description of the User Group. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L16) + +*** + +### handle? + +```ts +optional handle: string; +``` + +#### Description + +A mention handle. Must be unique among channels, users and User Groups. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L18) + +*** + +### include\_count? + +```ts +optional include_count: boolean; +``` + +#### Description + +Include the number of users in each User Group. + +#### Inherited from + +`UsergroupsIncludeCount.include_count` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) + +*** + +### name + +```ts +name: string; +``` + +#### Description + +A name for the User Group. Must be unique among User Groups. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L12) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md new file mode 100644 index 000000000..420717121 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md @@ -0,0 +1,81 @@ +# Interface: UsergroupsDisableArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` + +## Properties + +### include\_count? + +```ts +optional include_count: boolean; +``` + +#### Description + +Include the number of users in each User Group. + +#### Inherited from + +`UsergroupsIncludeCount.include_count` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup + +```ts +usergroup: string; +``` + +#### Description + +The encoded ID of the User Group to disable. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md new file mode 100644 index 000000000..3a01fba51 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md @@ -0,0 +1,81 @@ +# Interface: UsergroupsEnableArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` + +## Properties + +### include\_count? + +```ts +optional include_count: boolean; +``` + +#### Description + +Include the number of users in each User Group. + +#### Inherited from + +`UsergroupsIncludeCount.include_count` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup + +```ts +usergroup: string; +``` + +#### Description + +The encoded ID of the User Group to enable. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L28) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md new file mode 100644 index 000000000..9c58e24e7 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md @@ -0,0 +1,161 @@ +# Interface: UsergroupsUpdateArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable`.`Partial`\<[`UsergroupsCreateArguments`](UsergroupsCreateArguments.md)\> + +## Properties + +### channels? + +```ts +optional channels: string; +``` + +#### Description + +A comma separated string of encoded channel IDs for which the User Group uses as a default. + +#### Inherited from + +`Partial.channels` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L14) + +*** + +### description? + +```ts +optional description: string; +``` + +#### Description + +A short description of the User Group. + +#### Inherited from + +`Partial.description` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L16) + +*** + +### handle? + +```ts +optional handle: string; +``` + +#### Description + +A mention handle. Must be unique among channels, users and User Groups. + +#### Inherited from + +`Partial.handle` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L18) + +*** + +### include\_count? + +```ts +optional include_count: boolean; +``` + +#### Description + +Include the number of users in each User Group. + +#### Inherited from + +`Partial.include_count` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) + +*** + +### name? + +```ts +optional name: string; +``` + +#### Description + +A name for the User Group. Must be unique among User Groups. + +#### Inherited from + +`Partial.name` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L12) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup + +```ts +usergroup: string; +``` + +#### Description + +The encoded ID of the User Group to update. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md new file mode 100644 index 000000000..808006e7f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md @@ -0,0 +1,77 @@ +# Interface: UsergroupsUsersListArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable` + +## Properties + +### include\_disabled? + +```ts +optional include_disabled: boolean; +``` + +#### Description + +Allow results that involve disabled User Groups. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L50) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup + +```ts +usergroup: string; +``` + +#### Description + +The encoded ID of the User Group to list users for. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L48) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md new file mode 100644 index 000000000..b08c913e8 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md @@ -0,0 +1,98 @@ +# Interface: UsergroupsUsersUpdateArguments + +## Extends + +- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` + +## Properties + +### include\_count? + +```ts +optional include_count: boolean; +``` + +#### Description + +Include the number of users in each User Group. + +#### Inherited from + +`UsergroupsIncludeCount.include_count` + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### usergroup + +```ts +usergroup: string; +``` + +#### Description + +The encoded ID of the User Group to update users for. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L56) + +*** + +### users + +```ts +users: string; +``` + +#### Description + +A comma separated string of encoded user IDs that represent the entire list of users for +the User Group. + +#### Defined in + +[packages/web-api/src/types/request/usergroups.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L61) diff --git a/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md b/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md new file mode 100644 index 000000000..57609021d --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md @@ -0,0 +1,142 @@ +# Interface: UsersConversationsArguments + +## Extends + +- `TokenOverridable`.`CursorPaginationEnabled`.`OptionalTeamAssignable` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### exclude\_archived? + +```ts +optional exclude_archived: boolean; +``` + +#### Description + +Set to `true` to exclude archived channels from the list. Default is `false`. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L13) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### types? + +```ts +optional types: string; +``` + +#### Description + +Mix and match channel types by providing a comma-separated list of any combination of +`public_channel`, `private_channel`, `mpim` and `im`. Defaults to `public_channel`. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L18) + +*** + +### user? + +```ts +optional user: string; +``` + +#### Description + +Browse conversations by a specific user ID's membership. +Non-public channels are restricted to those where the calling user shares membership. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md b/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md new file mode 100644 index 000000000..6fc61ea40 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md @@ -0,0 +1,25 @@ +# Interface: UsersDeletePhotoArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md b/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md new file mode 100644 index 000000000..bf99a36eb --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md @@ -0,0 +1,45 @@ +# Interface: UsersDiscoverableContactsLookupArguments + +## Extends + +- `Email`.`TokenOverridable` + +## Properties + +### email + +```ts +email: string; +``` + +#### Description + +An email address belonging to a user in the workspace + +#### Inherited from + +`Email.email` + +#### Defined in + +[packages/web-api/src/types/request/users.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L7) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md b/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md new file mode 100644 index 000000000..a3c1d6d03 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md @@ -0,0 +1,41 @@ +# Interface: UsersGetPresenceArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user? + +```ts +optional user: string; +``` + +#### Description + +User to get presence info on. Defaults to the authed user. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L32) diff --git a/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md b/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md new file mode 100644 index 000000000..70aac6f5a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md @@ -0,0 +1,25 @@ +# Interface: UsersIdentityArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersInfoArguments.md b/docs/content/reference/web-api/interfaces/UsersInfoArguments.md new file mode 100644 index 000000000..7ea08d370 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersInfoArguments.md @@ -0,0 +1,61 @@ +# Interface: UsersInfoArguments + +## Extends + +- `TokenOverridable`.`LocaleAware` + +## Properties + +### include\_locale? + +```ts +optional include_locale: boolean; +``` + +#### Description + +Set this to `true` to receive the locale with the response. + +#### Inherited from + +`LocaleAware.include_locale` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user + +```ts +user: string; +``` + +#### Description + +User to get info on. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/UsersListArguments.md b/docs/content/reference/web-api/interfaces/UsersListArguments.md new file mode 100644 index 000000000..21f88888b --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersListArguments.md @@ -0,0 +1,112 @@ +# Interface: UsersListArguments + +## Extends + +- `TokenOverridable`.`CursorPaginationEnabled`.`LocaleAware`.`OptionalTeamAssignable` + +## Properties + +### cursor? + +```ts +optional cursor: string; +``` + +#### Description + +Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute +returned by a previous request's `response_metadata`. +Default value fetches the first "page" of the collection. + +#### See + +[pagination](https://api.slack.com/docs/pagination) for more detail. + +#### Inherited from + +`CursorPaginationEnabled.cursor` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) + +*** + +### include\_locale? + +```ts +optional include_locale: boolean; +``` + +#### Description + +Set this to `true` to receive the locale with the response. + +#### Inherited from + +`LocaleAware.include_locale` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) + +*** + +### limit? + +```ts +optional limit: number; +``` + +#### Description + +The maximum number of items to return. Fewer than the requested number of items may be returned, +even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. + +#### Inherited from + +`CursorPaginationEnabled.limit` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) + +*** + +### team\_id? + +```ts +optional team_id: string; +``` + +#### Description + +If using an org token, `team_id` is required. + +#### Inherited from + +`OptionalTeamAssignable.team_id` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md b/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md new file mode 100644 index 000000000..99e647c15 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md @@ -0,0 +1,45 @@ +# Interface: UsersLookupByEmailArguments + +## Extends + +- `Email`.`TokenOverridable` + +## Properties + +### email + +```ts +email: string; +``` + +#### Description + +An email address belonging to a user in the workspace + +#### Inherited from + +`Email.email` + +#### Defined in + +[packages/web-api/src/types/request/users.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L7) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md b/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md new file mode 100644 index 000000000..4641f11fb --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md @@ -0,0 +1,58 @@ +# Interface: UsersProfileGetArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### include\_labels? + +```ts +optional include_labels: boolean; +``` + +#### Description + +Include labels for each ID in custom profile fields. +Using this parameter will heavily rate-limit your requests and is not recommended. Defaults to `false`. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L68) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user? + +```ts +optional user: string; +``` + +#### Description + +User to retrieve profile info for. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L70) diff --git a/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md b/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md new file mode 100644 index 000000000..956f683da --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md @@ -0,0 +1,103 @@ +# Interface: UsersProfileSetArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### name? + +```ts +optional name: string; +``` + +#### Description + +Name of a single profile field to set. If both `name` and `profile` are set, `name` takes precedence. + +#### See + +[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). + +#### Defined in + +[packages/web-api/src/types/request/users.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L87) + +*** + +### profile? + +```ts +optional profile: Record; +``` + +#### Description + +Sets profile fields using a single argument. +Collection of key:value pairs presented. +At most 50 fields may be set. Each field name is limited to 255 characters. + +#### See + +[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). + +#### Defined in + +[packages/web-api/src/types/request/users.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L80) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user? + +```ts +optional user: string; +``` + +#### Description + +ID of user to change. This argument may only be specified by admins on paid teams. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L82) + +*** + +### value? + +```ts +optional value: string; +``` + +#### Description + +Value to set for the profile field specified by `name`. Usable only if profile is not passed. + +#### See + +[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). + +#### Defined in + +[packages/web-api/src/types/request/users.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L92) diff --git a/docs/content/reference/web-api/interfaces/UsersSelect.md b/docs/content/reference/web-api/interfaces/UsersSelect.md new file mode 100644 index 000000000..bd6778f0a --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersSelect.md @@ -0,0 +1,135 @@ +# Interface: UsersSelect + +## Description + +This select menu will populate its options with a list of Slack users visible to the current user in the +active workspace. + +## See + + - [Select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Extends + +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) + +## Properties + +### action\_id? + +```ts +optional action_id: string; +``` + +@description: An identifier for this action. You can use this when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### focus\_on\_load? + +```ts +optional focus_on_load: boolean; +``` + +#### Description + +Indicates whether the element will be set to auto focus within the +[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. +Defaults to `false`. + +#### Inherited from + +[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 + +*** + +### initial\_user? + +```ts +optional initial_user: string; +``` + +#### Description + +The user ID of any valid user to be pre-selected when the menu loads. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:188 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum +length for the `text` field in this object is 150 characters. + +#### Inherited from + +[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 + +*** + +### type + +```ts +type: "users_select"; +``` + +#### Description + +The type of element. In this case `type` is always `users_select`. + +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:184 diff --git a/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md b/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md new file mode 100644 index 000000000..513aecde0 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md @@ -0,0 +1,89 @@ +# Interface: UsersSetPhotoArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### crop\_w? + +```ts +optional crop_w: number; +``` + +#### Description + +Width/height of crop box (always square). + +#### Defined in + +[packages/web-api/src/types/request/users.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L51) + +*** + +### crop\_x? + +```ts +optional crop_x: number; +``` + +#### Description + +X coordinate of top-left corner of crop box. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L53) + +*** + +### crop\_y? + +```ts +optional crop_y: number; +``` + +#### Description + +Y coordinate of top-left corner of crop box. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L55) + +*** + +### image + +```ts +image: Buffer | Stream; +``` + +#### Description + +Image file contents. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L49) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md b/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md new file mode 100644 index 000000000..d6ee8d308 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md @@ -0,0 +1,41 @@ +# Interface: UsersSetPresenceArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### presence + +```ts +presence: "auto" | "away"; +``` + +#### Description + +Either `auto` or `away`. + +#### Defined in + +[packages/web-api/src/types/request/users.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L60) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/VideoBlock.md b/docs/content/reference/web-api/interfaces/VideoBlock.md new file mode 100644 index 000000000..8e9814619 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/VideoBlock.md @@ -0,0 +1,206 @@ +# Interface: VideoBlock + +## Description + +Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g. +link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you +must have the [`links.embed:write` scope](https://api.slack.com/scopes/links.embed:write). + +## See + +[Video block reference](https://api.slack.com/reference/block-kit/blocks#video). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A tooltip for the video. Required for accessibility. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:203 + +*** + +### author\_name? + +```ts +optional author_name: string; +``` + +#### Description + +Author name to be displayed. Must be less than 50 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:216 + +*** + +### block\_id? + +```ts +optional block_id: string; +``` + +#### Description + +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. +You can use this `block_id` when you receive an interaction payload to +[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of +a message. If a message is updated, use a new `block_id`. + +#### Inherited from + +[`Block`](Block.md).[`block_id`](Block.md#block_id) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 + +*** + +### description? + +```ts +optional description: PlainTextElement; +``` + +#### Description + +Description for video using a [PlainTextElement](PlainTextElement.md) object. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:228 + +*** + +### provider\_icon\_url? + +```ts +optional provider_icon_url: string; +``` + +#### Description + +Icon for the video provider, e.g. YouTube icon. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:224 + +*** + +### provider\_name? + +```ts +optional provider_name: string; +``` + +#### Description + +The originating application or domain of the video, e.g. YouTube. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:220 + +*** + +### thumbnail\_url + +```ts +thumbnail_url: string; +``` + +#### Description + +The thumbnail image URL. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:199 + +*** + +### title + +```ts +title: PlainTextElement; +``` + +#### Description + +Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within must be less than 200 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:207 + +*** + +### title\_url? + +```ts +optional title_url: string; +``` + +#### Description + +Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. +Must go to an HTTPS URL. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:212 + +*** + +### type + +```ts +type: "video"; +``` + +#### Description + +The type of block. For a video block, `type` is always `video`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:189 + +*** + +### video\_url + +```ts +video_url: string; +``` + +#### Description + +The URL to be embedded. Must match any existing +[unfurl domains](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains) within the app +and point to a HTTPS URL. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:195 diff --git a/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md b/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md new file mode 100644 index 000000000..27746541f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md @@ -0,0 +1,85 @@ +# Interface: ViewsPublishArguments + +## Extends + +- `BaseViewsArguments`.`TokenOverridable`.`ViewHash` + +## Properties + +### hash? + +```ts +optional hash: string; +``` + +#### Description + +A string that represents view state to protect against possible race conditions. + +#### See + +[Avoiding race conditions when using views](https://api.slack.com/surfaces/modals#handling_race_conditions). + +#### Inherited from + +`ViewHash.hash` + +#### Defined in + +[packages/web-api/src/types/request/views.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L36) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### user\_id + +```ts +user_id: string; +``` + +#### Description + +ID of the user you want publish a view to. + +#### Defined in + +[packages/web-api/src/types/request/views.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L42) + +*** + +### view + +```ts +view: View; +``` + +#### Description + +A [view payload](https://api.slack.com/reference/surfaces/views). + +#### Inherited from + +`BaseViewsArguments.view` + +#### Defined in + +[packages/web-api/src/types/request/views.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L7) diff --git a/docs/content/reference/web-api/interfaces/WebAPICallResult.md b/docs/content/reference/web-api/interfaces/WebAPICallResult.md new file mode 100644 index 000000000..7cd7ea695 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebAPICallResult.md @@ -0,0 +1,73 @@ +# Interface: WebAPICallResult + +## Properties + +### error? + +```ts +optional error: string; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L93) + +*** + +### ok + +```ts +ok: boolean; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L92) + +*** + +### response\_metadata? + +```ts +optional response_metadata: object; +``` + +#### acceptedScopes? + +```ts +optional acceptedScopes: string[]; +``` + +#### messages? + +```ts +optional messages: string[]; +``` + +#### next\_cursor? + +```ts +optional next_cursor: string; +``` + +#### retryAfter? + +```ts +optional retryAfter: number; +``` + +#### scopes? + +```ts +optional scopes: string[]; +``` + +#### warnings? + +```ts +optional warnings: string[]; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L94) diff --git a/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md b/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md new file mode 100644 index 000000000..d2d213ab8 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md @@ -0,0 +1,167 @@ +# Interface: WebAPIHTTPError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### body? + +```ts +optional body: any; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L57) + +*** + +### code + +```ts +code: HTTPError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[packages/web-api/src/errors.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L52) + +*** + +### errno? + +```ts +optional errno: number; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:268 + +*** + +### headers + +```ts +headers: IncomingHttpHeaders; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L55) + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`message`](CodedError.md#message) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`name`](CodedError.md#name) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### path? + +```ts +optional path: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`path`](CodedError.md#path) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:270 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + +### statusCode + +```ts +statusCode: number; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L53) + +*** + +### statusMessage + +```ts +statusMessage: string; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L54) + +*** + +### syscall? + +```ts +optional syscall: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md b/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md new file mode 100644 index 000000000..c74976db3 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md @@ -0,0 +1,139 @@ +# Interface: WebAPIPlatformError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: PlatformError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[packages/web-api/src/errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L40) + +*** + +### data + +```ts +data: WebAPICallResult & object; +``` + +#### Type declaration + +##### error + +```ts +error: string; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L41) + +*** + +### errno? + +```ts +optional errno: number; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:268 + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`message`](CodedError.md#message) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`name`](CodedError.md#name) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### path? + +```ts +optional path: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`path`](CodedError.md#path) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:270 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + +### syscall? + +```ts +optional syscall: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md b/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md new file mode 100644 index 000000000..0bae9cb23 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md @@ -0,0 +1,131 @@ +# Interface: WebAPIRateLimitedError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: RateLimitedError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[packages/web-api/src/errors.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L61) + +*** + +### errno? + +```ts +optional errno: number; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:268 + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`message`](CodedError.md#message) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`name`](CodedError.md#name) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### path? + +```ts +optional path: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`path`](CodedError.md#path) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:270 + +*** + +### retryAfter + +```ts +retryAfter: number; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L62) + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + +### syscall? + +```ts +optional syscall: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIRequestError.md b/docs/content/reference/web-api/interfaces/WebAPIRequestError.md new file mode 100644 index 000000000..04fd79c8f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebAPIRequestError.md @@ -0,0 +1,131 @@ +# Interface: WebAPIRequestError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: RequestError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[packages/web-api/src/errors.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L47) + +*** + +### errno? + +```ts +optional errno: number; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:268 + +*** + +### message + +```ts +message: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`message`](CodedError.md#message) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +*** + +### name + +```ts +name: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`name`](CodedError.md#name) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +*** + +### original + +```ts +original: Error; +``` + +#### Defined in + +[packages/web-api/src/errors.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L48) + +*** + +### path? + +```ts +optional path: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`path`](CodedError.md#path) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:270 + +*** + +### stack? + +```ts +optional stack: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) + +#### Defined in + +docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +*** + +### syscall? + +```ts +optional syscall: string; +``` + +#### Inherited from + +[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) + +#### Defined in + +packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebClientOptions.md b/docs/content/reference/web-api/interfaces/WebClientOptions.md new file mode 100644 index 000000000..233716196 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WebClientOptions.md @@ -0,0 +1,154 @@ +# Interface: WebClientOptions + +## Properties + +### agent? + +```ts +optional agent: Agent; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L68) + +*** + +### attachOriginalToWebAPIRequestError? + +```ts +optional attachOriginalToWebAPIRequestError: boolean; +``` + +Indicates whether to attach the original error to a Web API request error. +When set to true, the original error object will be attached to the Web API request error. + +#### Default + +```ts +true +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L80) + +*** + +### headers? + +```ts +optional headers: Record; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:72](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L72) + +*** + +### logLevel? + +```ts +optional logLevel: LogLevel; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L65) + +*** + +### logger? + +```ts +optional logger: Logger; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L64) + +*** + +### maxRequestConcurrency? + +```ts +optional maxRequestConcurrency: number; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L66) + +*** + +### rejectRateLimitedCalls? + +```ts +optional rejectRateLimitedCalls: boolean; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L71) + +*** + +### retryConfig? + +```ts +optional retryConfig: RetryOptions; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L67) + +*** + +### slackApiUrl? + +```ts +optional slackApiUrl: string; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L63) + +*** + +### teamId? + +```ts +optional teamId: string; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L73) + +*** + +### timeout? + +```ts +optional timeout: number; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L70) + +*** + +### tls? + +```ts +optional tls: TLSOptions; +``` + +#### Defined in + +[packages/web-api/src/WebClient.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L69) diff --git a/docs/content/reference/web-api/interfaces/WorkflowButton.md b/docs/content/reference/web-api/interfaces/WorkflowButton.md new file mode 100644 index 000000000..198f6c865 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WorkflowButton.md @@ -0,0 +1,153 @@ +# Interface: WorkflowButton + +## Description + +Allows users to run a [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) with customizable inputs. + +## See + +[Workflow button element reference](https://api.slack.com/reference/block-kit/block-elements#workflow_button). + +## Extends + +- [`Confirmable`](Confirmable.md) + +## Properties + +### accessibility\_label? + +```ts +optional accessibility_label: string; +``` + +#### Description + +A label for longer descriptive text about a button element. This label will be read out by screen +readers instead of the button `text` object. Maximum length for this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:630 + +*** + +### confirm? + +```ts +optional confirm: ConfirmationDialog; +``` + +#### Description + +A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted +with. + +#### Inherited from + +[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 + +*** + +### style? + +```ts +optional style: "danger" | "primary"; +``` + +#### Description + +Decorates buttons with alternative visual color schemes. Use this option with restraint. +`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should +only be used for one button within a set. +`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even +more sparingly than primary. +If you don't include this field, the default button style will be used. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:625 + +*** + +### text + +```ts +text: PlainTextElement; +``` + +#### Description + +A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. +Maximum length for the `text` in this field is 75 characters. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:585 + +*** + +### type + +```ts +type: "workflow_button"; +``` + +#### Description + +The type of element. In this case `type` is always `workflow_button`. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:580 + +*** + +### workflow + +```ts +workflow: object; +``` + +#### trigger + +```ts +trigger: object; +``` + +##### Description + +Properties of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) +that will be invoked via this button. + +#### trigger.customizable\_input\_parameters? + +```ts +optional customizable_input_parameters: object[]; +``` + +##### Description + +List of customizable input parameters and their values. Should match input parameters specified on +the provided trigger. + +#### trigger.url + +```ts +url: string; +``` + +##### Description + +The trigger URL of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) + +#### Description + +A workflow object that contains details about the workflow that will run when the button is clicked. + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:589 diff --git a/docs/content/reference/web-api/interfaces/WorkflowStepView.md b/docs/content/reference/web-api/interfaces/WorkflowStepView.md new file mode 100644 index 000000000..9ffa47536 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WorkflowStepView.md @@ -0,0 +1,79 @@ +# Interface: ~~WorkflowStepView~~ + +[Configuration modal](https://api.slack.com/legacy/workflows/steps#handle_config_view) for [legacy Workflow Steps from Apps](https://api.slack.com/legacy/workflows/steps). + +## Deprecated + +Steps from Apps are deprecated and will no longer be executed starting September 12, 2024. For more information, see our [deprecation announcement](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). + +## Properties + +### ~~blocks~~ + +```ts +blocks: (Block | KnownBlock)[]; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:28 + +*** + +### ~~callback\_id?~~ + +```ts +optional callback_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:30 + +*** + +### ~~external\_id?~~ + +```ts +optional external_id: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:32 + +*** + +### ~~private\_metadata?~~ + +```ts +optional private_metadata: string; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:29 + +*** + +### ~~submit\_disabled?~~ + +```ts +optional submit_disabled: boolean; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:31 + +*** + +### ~~type~~ + +```ts +type: "workflow_step"; +``` + +#### Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:27 diff --git a/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md new file mode 100644 index 000000000..ec0e0c1b5 --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md @@ -0,0 +1,49 @@ +# Interface: WorkflowsStepCompletedArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### outputs? + +```ts +optional outputs: Record; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L9) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_step\_execute\_id + +```ts +workflow_step_execute_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L8) diff --git a/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md new file mode 100644 index 000000000..5b766087f --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md @@ -0,0 +1,55 @@ +# Interface: WorkflowsStepFailedArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### error + +```ts +error: object; +``` + +#### message + +```ts +message: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L14) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_step\_execute\_id + +```ts +workflow_step_execute_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md new file mode 100644 index 000000000..0390e1dec --- /dev/null +++ b/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md @@ -0,0 +1,89 @@ +# Interface: WorkflowsUpdateStepArguments + +## Extends + +- `TokenOverridable` + +## Properties + +### inputs? + +```ts +optional inputs: object; +``` + +#### Index Signature + + \[`name`: `string`\]: `object` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L23) + +*** + +### outputs? + +```ts +optional outputs: object[]; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L34) + +*** + +### step\_image\_url? + +```ts +optional step_image_url: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L21) + +*** + +### step\_name? + +```ts +optional step_name: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L22) + +*** + +### token? + +```ts +optional token: string; +``` + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +`TokenOverridable.token` + +#### Defined in + +[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +*** + +### workflow\_step\_edit\_id + +```ts +workflow_step_edit_id: string; +``` + +#### Defined in + +[packages/web-api/src/types/request/workflows.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L20) diff --git a/docs/content/reference/web-api/type-aliases/APITestArguments.md b/docs/content/reference/web-api/type-aliases/APITestArguments.md new file mode 100644 index 000000000..608e79b7d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/APITestArguments.md @@ -0,0 +1,21 @@ +# Type Alias: APITestArguments + +```ts +type APITestArguments: OptionalArgument; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +#### Description + +Error response to return. + +## Defined in + +[packages/web-api/src/types/request/api.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/api.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md new file mode 100644 index 000000000..f9c7a1e3a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAnalyticsGetFileArguments + +```ts +type AdminAnalyticsGetFileArguments: TokenOverridable & MemberArgs | PublicChannelArgs; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/analytics.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/analytics.ts#L44) diff --git a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md new file mode 100644 index 000000000..45bc209ac --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminAnalyticsGetFileResponse + +```ts +type AdminAnalyticsGetFileResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file\_data? + +```ts +optional file_data: (AdminAnalyticsMemberDetails | AdminAnalyticsPublicChannelDetails | AdminAnalyticsPublicChannelMetadataDetails)[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md new file mode 100644 index 000000000..0451934b4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsActivitiesListArguments + +```ts +type AdminAppsActivitiesListArguments: OptionalArgument & Partial & TokenOverridable & CursorPaginationEnabled & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md new file mode 100644 index 000000000..72b43cdc2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminAppsActivitiesListResponse + +```ts +type AdminAppsActivitiesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### activities? + +```ts +optional activities: Activity[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md new file mode 100644 index 000000000..5cf57cc72 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsApproveArguments + +```ts +type AdminAppsApproveArguments: AppOrRequestID & TeamOrEnterpriseID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L55) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md new file mode 100644 index 000000000..69d36ad34 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAppsApproveResponse + +```ts +type AdminAppsApproveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsApproveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsApproveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md new file mode 100644 index 000000000..b4d0efd60 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsApprovedListArguments + +```ts +type AdminAppsApprovedListArguments: Partial & TokenOverridable & CursorPaginationEnabled & Certified; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L58) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md new file mode 100644 index 000000000..42efda7c9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminAppsApprovedListResponse + +```ts +type AdminAppsApprovedListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### approved\_apps? + +```ts +optional approved_apps: ApprovedApp[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md new file mode 100644 index 000000000..c61aeaabb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsClearResolutionArguments + +```ts +type AdminAppsClearResolutionArguments: AppID & TeamOrEnterpriseID; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L62) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md new file mode 100644 index 000000000..026e4eb81 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAppsClearResolutionResponse + +```ts +type AdminAppsClearResolutionResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md new file mode 100644 index 000000000..6f2aa1dc6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminAppsConfigLookupResponse + +```ts +type AdminAppsConfigLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### configs? + +```ts +optional configs: Config[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md new file mode 100644 index 000000000..a7aa6a2cc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminAppsConfigSetResponse + +```ts +type AdminAppsConfigSetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md new file mode 100644 index 000000000..6b62cb53c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsRequestsCancelArguments + +```ts +type AdminAppsRequestsCancelArguments: RequestID & TeamOrEnterpriseID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L84) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md new file mode 100644 index 000000000..3933afbd0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAppsRequestsCancelResponse + +```ts +type AdminAppsRequestsCancelResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md new file mode 100644 index 000000000..61bd2e11b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsRequestsListArguments + +```ts +type AdminAppsRequestsListArguments: TeamOrEnterpriseID & Certified & TokenOverridable & CursorPaginationEnabled; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L87) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md new file mode 100644 index 000000000..956ef1abe --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminAppsRequestsListResponse + +```ts +type AdminAppsRequestsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### app\_requests? + +```ts +optional app_requests: AppRequest[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md new file mode 100644 index 000000000..33efa5dcb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsRestrictArguments + +```ts +type AdminAppsRestrictArguments: AppOrRequestID & TeamOrEnterpriseID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L91) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md new file mode 100644 index 000000000..e2179528f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAppsRestrictResponse + +```ts +type AdminAppsRestrictResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsRestrictResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRestrictResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md new file mode 100644 index 000000000..5af19dc30 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsRestrictedListArguments + +```ts +type AdminAppsRestrictedListArguments: TeamOrEnterpriseID & Certified & TokenOverridable & CursorPaginationEnabled; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L94) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md new file mode 100644 index 000000000..8fb3398a4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminAppsRestrictedListResponse + +```ts +type AdminAppsRestrictedListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### restricted\_apps? + +```ts +optional restricted_apps: RestrictedApp[]; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md new file mode 100644 index 000000000..86f2e3ff2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminAppsUninstallArguments + +```ts +type AdminAppsUninstallArguments: AppID & TeamOrEnterpriseID; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/apps.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L98) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md new file mode 100644 index 000000000..bd246ebab --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAppsUninstallResponse + +```ts +type AdminAppsUninstallResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAppsUninstallResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsUninstallResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md new file mode 100644 index 000000000..b95775790 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAuthPolicyAssignEntitiesResponse + +```ts +type AdminAuthPolicyAssignEntitiesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### entity\_total\_count? + +```ts +optional entity_total_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md new file mode 100644 index 000000000..c5fbc6563 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminAuthPolicyGetEntitiesResponse + +```ts +type AdminAuthPolicyGetEntitiesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### entities? + +```ts +optional entities: Entity[]; +``` + +### entity\_total\_count? + +```ts +optional entity_total_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md new file mode 100644 index 000000000..ede5beadb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminAuthPolicyRemoveEntitiesResponse + +```ts +type AdminAuthPolicyRemoveEntitiesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### entity\_total\_count? + +```ts +optional entity_total_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md new file mode 100644 index 000000000..2968a79d9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminBarriersCreateResponse + +```ts +type AdminBarriersCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### barrier? + +```ts +optional barrier: Barrier; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminBarriersCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md new file mode 100644 index 000000000..92bc8312f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminBarriersDeleteResponse + +```ts +type AdminBarriersDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md b/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md new file mode 100644 index 000000000..d9b4b0e62 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminBarriersListArguments + +```ts +type AdminBarriersListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/barriers.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L27) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md new file mode 100644 index 000000000..3d9ed58da --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminBarriersListResponse + +```ts +type AdminBarriersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### barriers? + +```ts +optional barriers: Barrier[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminBarriersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md new file mode 100644 index 000000000..f1c665954 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminBarriersUpdateResponse + +```ts +type AdminBarriersUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### barrier? + +```ts +optional barrier: Barrier; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md new file mode 100644 index 000000000..fce99cda4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsArchiveResponse + +```ts +type AdminConversationsArchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md new file mode 100644 index 000000000..c914058f9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminConversationsBulkArchiveResponse + +```ts +type AdminConversationsBulkArchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bulk\_action\_id? + +```ts +optional bulk_action_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### not\_added? + +```ts +optional not_added: NotAdded[]; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md new file mode 100644 index 000000000..0a83ac72c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminConversationsBulkDeleteResponse + +```ts +type AdminConversationsBulkDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bulk\_action\_id? + +```ts +optional bulk_action_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### not\_added? + +```ts +optional not_added: NotAdded[]; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md new file mode 100644 index 000000000..048a65470 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminConversationsBulkMoveResponse + +```ts +type AdminConversationsBulkMoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bulk\_action\_id? + +```ts +optional bulk_action_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### not\_added? + +```ts +optional not_added: NotAdded[]; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md new file mode 100644 index 000000000..684d9b9cd --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsConvertToPrivateResponse + +```ts +type AdminConversationsConvertToPrivateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md new file mode 100644 index 000000000..7a32de827 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsConvertToPublicResponse + +```ts +type AdminConversationsConvertToPublicResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md new file mode 100644 index 000000000..d65f91c8f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsCreateArguments + +```ts +type AdminConversationsCreateArguments: TokenOverridable & WorkspaceAccess & object; +``` + +## Type declaration + +### description? + +```ts +optional description: string; +``` + +#### Description + +Description of the public or private channel to create. + +### is\_private + +```ts +is_private: boolean; +``` + +#### Description + +When `true`, creates a private channel instead of a public channel. + +### name + +```ts +name: string; +``` + +#### Description + +Name of the public or private channel to create. + +## Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L81) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md new file mode 100644 index 000000000..cafb56265 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsCreateResponse + +```ts +type AdminConversationsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_id? + +```ts +optional channel_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md new file mode 100644 index 000000000..a25d96b3d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsDeleteResponse + +```ts +type AdminConversationsDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md new file mode 100644 index 000000000..a669bf27c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsDisconnectSharedResponse + +```ts +type AdminConversationsDisconnectSharedResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md new file mode 100644 index 000000000..5e7f9128f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminConversationsEKMListOriginalConnectedChannelInfoArguments + +```ts +type AdminConversationsEKMListOriginalConnectedChannelInfoArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L100) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md new file mode 100644 index 000000000..24be302cc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsEkmListOriginalConnectedChannelInfoResponse + +```ts +type AdminConversationsEkmListOriginalConnectedChannelInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md new file mode 100644 index 000000000..86667f227 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsGetConversationPrefsResponse + +```ts +type AdminConversationsGetConversationPrefsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### prefs? + +```ts +optional prefs: Prefs; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md new file mode 100644 index 000000000..648310dac --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsGetCustomRetentionResponse + +```ts +type AdminConversationsGetCustomRetentionResponse: WebAPICallResult & object; +``` + +## Type declaration + +### duration\_days? + +```ts +optional duration_days: number; +``` + +### error? + +```ts +optional error: string; +``` + +### is\_policy\_enabled? + +```ts +optional is_policy_enabled: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md new file mode 100644 index 000000000..6844e1360 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsGetTeamsResponse + +```ts +type AdminConversationsGetTeamsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team\_ids? + +```ts +optional team_ids: string[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md new file mode 100644 index 000000000..2f5b88c61 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsInviteResponse + +```ts +type AdminConversationsInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### failed\_user\_ids? + +```ts +optional failed_user_ids: FailedUserids; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md new file mode 100644 index 000000000..b702c4e70 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsLookupResponse + +```ts +type AdminConversationsLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_ids? + +```ts +optional channel_ids: string[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md new file mode 100644 index 000000000..fb56b5f57 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsRemoveCustomRetentionResponse + +```ts +type AdminConversationsRemoveCustomRetentionResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md new file mode 100644 index 000000000..01dff0957 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsRenameResponse + +```ts +type AdminConversationsRenameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md new file mode 100644 index 000000000..9701db635 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsRestrictAccessAddGroupResponse + +```ts +type AdminConversationsRestrictAccessAddGroupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md new file mode 100644 index 000000000..37353abfc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsRestrictAccessListGroupsResponse + +```ts +type AdminConversationsRestrictAccessListGroupsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group\_ids? + +```ts +optional group_ids: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md new file mode 100644 index 000000000..756fc431c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsRestrictAccessRemoveGroupResponse + +```ts +type AdminConversationsRestrictAccessRemoveGroupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsRestrictAccessRemoveGroupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessRemoveGroupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md new file mode 100644 index 000000000..ea1f8db29 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminConversationsSearchArguments + +```ts +type AdminConversationsSearchArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/conversations.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L153) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md new file mode 100644 index 000000000..6eee36532 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md @@ -0,0 +1,59 @@ +# Type Alias: AdminConversationsSearchResponse + +```ts +type AdminConversationsSearchResponse: WebAPICallResult & object; +``` + +## Type declaration + +### conversations? + +```ts +optional conversations: Conversation[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### next\_cursor? + +```ts +optional next_cursor: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### total\_count? + +```ts +optional total_count: number; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsSearchResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md new file mode 100644 index 000000000..c3393c39a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsSetConversationPrefsResponse + +```ts +type AdminConversationsSetConversationPrefsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsSetConversationPrefsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetConversationPrefsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md new file mode 100644 index 000000000..75aa99a93 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsSetCustomRetentionResponse + +```ts +type AdminConversationsSetCustomRetentionResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsSetCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md new file mode 100644 index 000000000..fc8c6d0de --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminConversationsSetTeamsResponse + +```ts +type AdminConversationsSetTeamsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsSetTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md new file mode 100644 index 000000000..0025a2a98 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminConversationsUnarchiveResponse + +```ts +type AdminConversationsUnarchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md new file mode 100644 index 000000000..4ed71d345 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsWhitelistAddResponse + +```ts +type AdminConversationsWhitelistAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsWhitelistAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md new file mode 100644 index 000000000..727b9abc4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminConversationsWhitelistListGroupsLinkedToChannelResponse + +```ts +type AdminConversationsWhitelistListGroupsLinkedToChannelResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group\_ids? + +```ts +optional group_ids: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md new file mode 100644 index 000000000..38d690018 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminConversationsWhitelistRemoveResponse + +```ts +type AdminConversationsWhitelistRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminConversationsWhitelistRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md new file mode 100644 index 000000000..a50b506a0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminEmojiAddAliasResponse + +```ts +type AdminEmojiAddAliasResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminEmojiAddAliasResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiAddAliasResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md new file mode 100644 index 000000000..29264cd8e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminEmojiAddResponse + +```ts +type AdminEmojiAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminEmojiAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md b/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md new file mode 100644 index 000000000..ccac7a109 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminEmojiListArguments + +```ts +type AdminEmojiListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/emoji.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L32) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md new file mode 100644 index 000000000..69f23043b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md @@ -0,0 +1,51 @@ +# Type Alias: AdminEmojiListResponse + +```ts +type AdminEmojiListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### emoji? + +```ts +optional emoji: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `Emoji` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminEmojiListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md new file mode 100644 index 000000000..845ae8e81 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminEmojiRemoveResponse + +```ts +type AdminEmojiRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminEmojiRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md new file mode 100644 index 000000000..381753e90 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminEmojiRenameResponse + +```ts +type AdminEmojiRenameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminEmojiRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md new file mode 100644 index 000000000..6f123aae4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminFunctionsListResponse + +```ts +type AdminFunctionsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### functions? + +```ts +optional functions: Function[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminFunctionsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md new file mode 100644 index 000000000..1cbcceab5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md @@ -0,0 +1,57 @@ +# Type Alias: AdminFunctionsPermissionsLookupResponse + +```ts +type AdminFunctionsPermissionsLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Errors; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### permissions? + +```ts +optional permissions: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `Permission` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md new file mode 100644 index 000000000..355dd0d2d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminFunctionsPermissionsSetResponse + +```ts +type AdminFunctionsPermissionsSetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminFunctionsPermissionsSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsPermissionsSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md new file mode 100644 index 000000000..aaa3935a4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminInviteRequestsApproveResponse + +```ts +type AdminInviteRequestsApproveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminInviteRequestsApproveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsApproveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md new file mode 100644 index 000000000..060ccb13c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminInviteRequestsApprovedListResponse + +```ts +type AdminInviteRequestsApprovedListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### approved\_requests? + +```ts +optional approved_requests: ApprovedRequest[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminInviteRequestsApprovedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsApprovedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md new file mode 100644 index 000000000..431484cb5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminInviteRequestsDeniedListResponse + +```ts +type AdminInviteRequestsDeniedListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### denied\_requests? + +```ts +optional denied_requests: DeniedRequest[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminInviteRequestsDeniedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsDeniedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md new file mode 100644 index 000000000..2257d3053 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminInviteRequestsDenyResponse + +```ts +type AdminInviteRequestsDenyResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminInviteRequestsDenyResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsDenyResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md new file mode 100644 index 000000000..0764ccf0a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminInviteRequestsListResponse + +```ts +type AdminInviteRequestsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### invite\_requests? + +```ts +optional invite_requests: InviteRequest[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminInviteRequestsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md new file mode 100644 index 000000000..bc376c72a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminRolesAddAssignmentsResponse + +```ts +type AdminRolesAddAssignmentsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### rejected\_users? + +```ts +optional rejected_users: RejectedUser[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminRolesAddAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesAddAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md new file mode 100644 index 000000000..b7c96bfec --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminRolesListAssignmentsArguments + +```ts +type AdminRolesListAssignmentsArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & SortDir & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/roles.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L25) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md new file mode 100644 index 000000000..06bc3352d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminRolesListAssignmentsResponse + +```ts +type AdminRolesListAssignmentsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### role\_assignments? + +```ts +optional role_assignments: RoleAssignment[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminRolesListAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesListAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md new file mode 100644 index 000000000..12042bf01 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminRolesRemoveAssignmentsResponse + +```ts +type AdminRolesRemoveAssignmentsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminRolesRemoveAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesRemoveAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md new file mode 100644 index 000000000..862347c8f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminTeamsAdminsListResponse + +```ts +type AdminTeamsAdminsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### admin\_ids? + +```ts +optional admin_ids: string[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsAdminsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsAdminsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md new file mode 100644 index 000000000..bb90b4f52 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminTeamsCreateResponse + +```ts +type AdminTeamsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### team? + +```ts +optional team: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md new file mode 100644 index 000000000..3071782b8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminTeamsListArguments + +```ts +type AdminTeamsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/teams.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L23) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md new file mode 100644 index 000000000..922261718 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminTeamsListResponse + +```ts +type AdminTeamsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### teams? + +```ts +optional teams: Team[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md new file mode 100644 index 000000000..ba7b1682e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminTeamsOwnersListResponse + +```ts +type AdminTeamsOwnersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### owner\_ids? + +```ts +optional owner_ids: string[]; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsOwnersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsOwnersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md new file mode 100644 index 000000000..be7c592e8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminTeamsSettingsInfoResponse + +```ts +type AdminTeamsSettingsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team? + +```ts +optional team: Team; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md new file mode 100644 index 000000000..6ce27fe47 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminTeamsSettingsSetDefaultChannelsResponse + +```ts +type AdminTeamsSettingsSetDefaultChannelsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsSetDefaultChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDefaultChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md new file mode 100644 index 000000000..eebf471c8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminTeamsSettingsSetDescriptionResponse + +```ts +type AdminTeamsSettingsSetDescriptionResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsSetDescriptionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDescriptionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md new file mode 100644 index 000000000..975c4de1a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminTeamsSettingsSetDiscoverabilityResponse + +```ts +type AdminTeamsSettingsSetDiscoverabilityResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsSetDiscoverabilityResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDiscoverabilityResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md new file mode 100644 index 000000000..affc17940 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminTeamsSettingsSetIconResponse + +```ts +type AdminTeamsSettingsSetIconResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsSetIconResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetIconResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md new file mode 100644 index 000000000..08956b092 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminTeamsSettingsSetNameResponse + +```ts +type AdminTeamsSettingsSetNameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminTeamsSettingsSetNameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetNameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md new file mode 100644 index 000000000..f9b5e0fd0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsergroupsAddChannelsResponse + +```ts +type AdminUsergroupsAddChannelsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsergroupsAddChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsAddChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md new file mode 100644 index 000000000..2cb44dd6b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsergroupsAddTeamsResponse + +```ts +type AdminUsergroupsAddTeamsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsergroupsAddTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsAddTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md new file mode 100644 index 000000000..379383e1a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminUsergroupsListChannelsResponse + +```ts +type AdminUsergroupsListChannelsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channels? + +```ts +optional channels: Channel[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsergroupsListChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsListChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md new file mode 100644 index 000000000..bbb81f84c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsergroupsRemoveChannelsResponse + +```ts +type AdminUsergroupsRemoveChannelsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsergroupsRemoveChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsRemoveChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md new file mode 100644 index 000000000..1751c47ce --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersAssignResponse + +```ts +type AdminUsersAssignResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersAssignResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersAssignResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md new file mode 100644 index 000000000..906bb4823 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminUsersInviteResponse + +```ts +type AdminUsersInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md b/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md new file mode 100644 index 000000000..8a3a1afef --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminUsersListArguments + +```ts +type AdminUsersListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/users.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L88) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md new file mode 100644 index 000000000..6818de6bd --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminUsersListResponse + +```ts +type AdminUsersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### users? + +```ts +optional users: User[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md new file mode 100644 index 000000000..93c40e032 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersRemoveResponse + +```ts +type AdminUsersRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md new file mode 100644 index 000000000..996a37907 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSessionClearSettingsResponse + +```ts +type AdminUsersSessionClearSettingsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionClearSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionClearSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md new file mode 100644 index 000000000..c84c369b3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminUsersSessionGetSettingsResponse + +```ts +type AdminUsersSessionGetSettingsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### no\_settings\_applied? + +```ts +optional no_settings_applied: string[]; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### session\_settings? + +```ts +optional session_settings: SessionSetting[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionGetSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionGetSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md new file mode 100644 index 000000000..b497a8fb8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminUsersSessionInvalidateResponse + +```ts +type AdminUsersSessionInvalidateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionInvalidateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionInvalidateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md new file mode 100644 index 000000000..672475ff4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminUsersSessionListArguments + +```ts +type AdminUsersSessionListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/users.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L113) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md new file mode 100644 index 000000000..3fbb9a344 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminUsersSessionListResponse + +```ts +type AdminUsersSessionListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### active\_sessions? + +```ts +optional active_sessions: ActiveSession[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md new file mode 100644 index 000000000..902121137 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSessionResetBulkResponse + +```ts +type AdminUsersSessionResetBulkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionResetBulkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionResetBulkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md new file mode 100644 index 000000000..36821e9aa --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSessionResetResponse + +```ts +type AdminUsersSessionResetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionResetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionResetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md new file mode 100644 index 000000000..52e181417 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSessionSetSettingsResponse + +```ts +type AdminUsersSessionSetSettingsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSessionSetSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionSetSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md new file mode 100644 index 000000000..e38d9f8d4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSetAdminResponse + +```ts +type AdminUsersSetAdminResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSetAdminResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetAdminResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md new file mode 100644 index 000000000..28c039da1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSetExpirationResponse + +```ts +type AdminUsersSetExpirationResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSetExpirationResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetExpirationResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md new file mode 100644 index 000000000..800186573 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSetOwnerResponse + +```ts +type AdminUsersSetOwnerResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSetOwnerResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetOwnerResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md new file mode 100644 index 000000000..7bc561d0b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersSetRegularResponse + +```ts +type AdminUsersSetRegularResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersSetRegularResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetRegularResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md new file mode 100644 index 000000000..dd9f46d9b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AdminUsersUnsupportedVersionsExportResponse + +```ts +type AdminUsersUnsupportedVersionsExportResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminUsersUnsupportedVersionsExportResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersUnsupportedVersionsExportResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md new file mode 100644 index 000000000..47927cec4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AdminWorkflowsCollaboratorsAddResponse + +```ts +type AdminWorkflowsCollaboratorsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Error[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminWorkflowsCollaboratorsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsCollaboratorsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md new file mode 100644 index 000000000..a95085bbe --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminWorkflowsCollaboratorsRemoveResponse + +```ts +type AdminWorkflowsCollaboratorsRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Error[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminWorkflowsCollaboratorsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsCollaboratorsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md new file mode 100644 index 000000000..4d7abcb9e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md @@ -0,0 +1,45 @@ +# Type Alias: AdminWorkflowsPermissionsLookupResponse + +```ts +type AdminWorkflowsPermissionsLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### permissions? + +```ts +optional permissions: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `Permission` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminWorkflowsPermissionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsPermissionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md new file mode 100644 index 000000000..76876c8b8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AdminWorkflowsSearchArguments + +```ts +type AdminWorkflowsSearchArguments: OptionalArgument & Partial & SortDir & TokenOverridable & CursorPaginationEnabled & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/admin/workflows.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L31) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md new file mode 100644 index 000000000..888072ac5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md @@ -0,0 +1,53 @@ +# Type Alias: AdminWorkflowsSearchResponse + +```ts +type AdminWorkflowsSearchResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### total\_found? + +```ts +optional total_found: number; +``` + +### workflows? + +```ts +optional workflows: Workflow[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminWorkflowsSearchResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsSearchResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md new file mode 100644 index 000000000..9cc86052d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AdminWorkflowsUnpublishResponse + +```ts +type AdminWorkflowsUnpublishResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AdminWorkflowsUnpublishResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsUnpublishResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ApiTestResponse.md b/docs/content/reference/web-api/type-aliases/ApiTestResponse.md new file mode 100644 index 000000000..9acb1b95d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ApiTestResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ApiTestResponse + +```ts +type ApiTestResponse: WebAPICallResult & object; +``` + +## Type declaration + +### args? + +```ts +optional args: Args; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ApiTestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ApiTestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md new file mode 100644 index 000000000..67dee1c59 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AppsConnectionsOpenArguments + +```ts +type AppsConnectionsOpenArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/apps.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L7) diff --git a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md new file mode 100644 index 000000000..34f14ff7b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AppsConnectionsOpenResponse + +```ts +type AppsConnectionsOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### url? + +```ts +optional url: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsConnectionsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsConnectionsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md b/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md new file mode 100644 index 000000000..53918ccaf --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AppsEventAuthorizationsListResponse + +```ts +type AppsEventAuthorizationsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### authorizations? + +```ts +optional authorizations: Authorization[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsEventAuthorizationsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsEventAuthorizationsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md new file mode 100644 index 000000000..03f104670 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md @@ -0,0 +1,65 @@ +# Type Alias: AppsManifestCreateResponse + +```ts +type AppsManifestCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### app\_id? + +```ts +optional app_id: string; +``` + +### credentials? + +```ts +optional credentials: Credentials; +``` + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Error[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### oauth\_authorize\_url? + +```ts +optional oauth_authorize_url: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsManifestCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md new file mode 100644 index 000000000..4bea0e8a1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsManifestDeleteResponse + +```ts +type AppsManifestDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsManifestDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md new file mode 100644 index 000000000..1de2ea755 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AppsManifestExportResponse + +```ts +type AppsManifestExportResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### manifest? + +```ts +optional manifest: Manifest; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsManifestExportResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestExportResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md new file mode 100644 index 000000000..dcc19cf5f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AppsManifestUpdateResponse + +```ts +type AppsManifestUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### app\_id? + +```ts +optional app_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### permissions\_updated? + +```ts +optional permissions_updated: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsManifestUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md new file mode 100644 index 000000000..028a77bbc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AppsManifestValidateResponse + +```ts +type AppsManifestValidateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Error[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsManifestValidateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestValidateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md new file mode 100644 index 000000000..e0e2a043f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsInfoResponse + +```ts +type AppsPermissionsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md new file mode 100644 index 000000000..a54d6737c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsRequestResponse + +```ts +type AppsPermissionsRequestResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsRequestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsRequestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md new file mode 100644 index 000000000..fd686ac84 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsResourcesListResponse + +```ts +type AppsPermissionsResourcesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsResourcesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsResourcesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md new file mode 100644 index 000000000..b12717095 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsScopesListResponse + +```ts +type AppsPermissionsScopesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsScopesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsScopesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md new file mode 100644 index 000000000..5da7cf284 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsUsersListResponse + +```ts +type AppsPermissionsUsersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md new file mode 100644 index 000000000..323249eba --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AppsPermissionsUsersRequestResponse + +```ts +type AppsPermissionsUsersRequestResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsPermissionsUsersRequestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsUsersRequestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md b/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md new file mode 100644 index 000000000..e5e130614 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md @@ -0,0 +1,41 @@ +# Type Alias: AppsUninstallResponse + +```ts +type AppsUninstallResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/AppsUninstallResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsUninstallResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md b/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md new file mode 100644 index 000000000..cce2a5828 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AuthRevokeArguments + +```ts +type AuthRevokeArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md b/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md new file mode 100644 index 000000000..c770ac0ba --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md @@ -0,0 +1,35 @@ +# Type Alias: AuthRevokeResponse + +```ts +type AuthRevokeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AuthRevokeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthRevokeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md new file mode 100644 index 000000000..fcba5aac3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AuthTeamsListArguments + +```ts +type AuthTeamsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/auth.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L14) diff --git a/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md new file mode 100644 index 000000000..60c8423c2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: AuthTeamsListResponse + +```ts +type AuthTeamsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### teams? + +```ts +optional teams: Team[]; +``` + +## Defined in + +[packages/web-api/src/types/response/AuthTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthTestArguments.md b/docs/content/reference/web-api/type-aliases/AuthTestArguments.md new file mode 100644 index 000000000..cb550955f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthTestArguments.md @@ -0,0 +1,9 @@ +# Type Alias: AuthTestArguments + +```ts +type AuthTestArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/auth.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L24) diff --git a/docs/content/reference/web-api/type-aliases/AuthTestResponse.md b/docs/content/reference/web-api/type-aliases/AuthTestResponse.md new file mode 100644 index 000000000..d5d8fd5b2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/AuthTestResponse.md @@ -0,0 +1,101 @@ +# Type Alias: AuthTestResponse + +```ts +type AuthTestResponse: WebAPICallResult & object; +``` + +## Type declaration + +### app\_id? + +```ts +optional app_id: string; +``` + +### app\_name? + +```ts +optional app_name: string; +``` + +### bot\_id? + +```ts +optional bot_id: string; +``` + +### enterprise\_id? + +```ts +optional enterprise_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### expires\_in? + +```ts +optional expires_in: number; +``` + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team? + +```ts +optional team: string; +``` + +### team\_id? + +```ts +optional team_id: string; +``` + +### url? + +```ts +optional url: string; +``` + +### user? + +```ts +optional user: string; +``` + +### user\_id? + +```ts +optional user_id: string; +``` + +## Defined in + +[packages/web-api/src/types/response/AuthTestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthTestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md new file mode 100644 index 000000000..61718e13d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md @@ -0,0 +1,47 @@ +# Type Alias: BookmarksAddResponse + +```ts +type BookmarksAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bookmark? + +```ts +optional bookmark: Bookmark; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/BookmarksAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md new file mode 100644 index 000000000..ada0c20f5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md @@ -0,0 +1,47 @@ +# Type Alias: BookmarksEditResponse + +```ts +type BookmarksEditResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bookmark? + +```ts +optional bookmark: Bookmark; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/BookmarksEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md new file mode 100644 index 000000000..f8da1e313 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: BookmarksListResponse + +```ts +type BookmarksListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bookmarks? + +```ts +optional bookmarks: Bookmark[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/BookmarksListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md new file mode 100644 index 000000000..6274ed501 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md @@ -0,0 +1,41 @@ +# Type Alias: BookmarksRemoveResponse + +```ts +type BookmarksRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/BookmarksRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md b/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md new file mode 100644 index 000000000..1b20cb0c7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: BotsInfoArguments + +```ts +type BotsInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/bots.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bots.ts#L6) diff --git a/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md b/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md new file mode 100644 index 000000000..d3cb6981c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: BotsInfoResponse + +```ts +type BotsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### bot? + +```ts +optional bot: Bot; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/BotsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BotsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallUser.md b/docs/content/reference/web-api/type-aliases/CallUser.md new file mode 100644 index 000000000..fb469b1a9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallUser.md @@ -0,0 +1,13 @@ +# Type Alias: CallUser + +```ts +type CallUser: CallUserSlack | CallUserExternal; +``` + +## Description + +For use in representing [users in a Slack Call](https://api.slack.com/apis/calls#users). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:4 diff --git a/docs/content/reference/web-api/type-aliases/CallsAddResponse.md b/docs/content/reference/web-api/type-aliases/CallsAddResponse.md new file mode 100644 index 000000000..d2a189ce0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsAddResponse.md @@ -0,0 +1,47 @@ +# Type Alias: CallsAddResponse + +```ts +type CallsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsEndResponse.md b/docs/content/reference/web-api/type-aliases/CallsEndResponse.md new file mode 100644 index 000000000..805760713 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsEndResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CallsEndResponse + +```ts +type CallsEndResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsEndResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsEndResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md b/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md new file mode 100644 index 000000000..ac801035e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CallsInfoResponse + +```ts +type CallsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md b/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md new file mode 100644 index 000000000..53808a027 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CallsParticipantsAddResponse + +```ts +type CallsParticipantsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsParticipantsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsParticipantsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md new file mode 100644 index 000000000..d94a07044 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CallsParticipantsRemoveResponse + +```ts +type CallsParticipantsRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsParticipantsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsParticipantsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md new file mode 100644 index 000000000..36a0caf6e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CallsUpdateResponse + +```ts +type CallsUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### call? + +```ts +optional call: Call; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/CallsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md new file mode 100644 index 000000000..f1d926e47 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md @@ -0,0 +1,53 @@ +# Type Alias: CanvasesAccessDeleteResponse + +```ts +type CanvasesAccessDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### failed\_to\_update\_channel\_ids? + +```ts +optional failed_to_update_channel_ids: string[]; +``` + +### failed\_to\_update\_user\_ids? + +```ts +optional failed_to_update_user_ids: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesAccessDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesAccessDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md new file mode 100644 index 000000000..bff76e048 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md @@ -0,0 +1,53 @@ +# Type Alias: CanvasesAccessSetResponse + +```ts +type CanvasesAccessSetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### failed\_to\_update\_channel\_ids? + +```ts +optional failed_to_update_channel_ids: string[]; +``` + +### failed\_to\_update\_user\_ids? + +```ts +optional failed_to_update_user_ids: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesAccessSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesAccessSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md b/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md new file mode 100644 index 000000000..4b2f99ebb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md @@ -0,0 +1,9 @@ +# Type Alias: CanvasesCreateArguments + +```ts +type CanvasesCreateArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/canvas.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L63) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md new file mode 100644 index 000000000..f700ba718 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md @@ -0,0 +1,53 @@ +# Type Alias: CanvasesCreateResponse + +```ts +type CanvasesCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### canvas\_id? + +```ts +optional canvas_id: string; +``` + +### detail? + +```ts +optional detail: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md new file mode 100644 index 000000000..3a5529b03 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md @@ -0,0 +1,41 @@ +# Type Alias: CanvasesDeleteResponse + +```ts +type CanvasesDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md new file mode 100644 index 000000000..1eee2e3f2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md @@ -0,0 +1,47 @@ +# Type Alias: CanvasesEditResponse + +```ts +type CanvasesEditResponse: WebAPICallResult & object; +``` + +## Type declaration + +### detail? + +```ts +optional detail: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md new file mode 100644 index 000000000..d0421e3e7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md @@ -0,0 +1,47 @@ +# Type Alias: CanvasesSectionsLookupResponse + +```ts +type CanvasesSectionsLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### sections? + +```ts +optional sections: Section[]; +``` + +## Defined in + +[packages/web-api/src/types/response/CanvasesSectionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesSectionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md new file mode 100644 index 000000000..a5beca4f9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChannelsArchiveResponse + +```ts +type ChannelsArchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md new file mode 100644 index 000000000..42a98beea --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsCreateResponse + +```ts +type ChannelsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md new file mode 100644 index 000000000..58feaf87a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md @@ -0,0 +1,77 @@ +# Type Alias: ChannelsHistoryResponse + +```ts +type ChannelsHistoryResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_actions\_count? + +```ts +optional channel_actions_count: number; +``` + +### channel\_actions\_ts? + +```ts +optional channel_actions_ts: number; +``` + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### latest? + +```ts +optional latest: string; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md new file mode 100644 index 000000000..88c69c832 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsInfoResponse + +```ts +type ChannelsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md new file mode 100644 index 000000000..2e76a7fb9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsInviteResponse + +```ts +type ChannelsInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md new file mode 100644 index 000000000..5098b7422 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsJoinResponse + +```ts +type ChannelsJoinResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsJoinResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsJoinResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md new file mode 100644 index 000000000..cb8ad3a41 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChannelsKickResponse + +```ts +type ChannelsKickResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md new file mode 100644 index 000000000..9b9b403a6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChannelsLeaveResponse + +```ts +type ChannelsLeaveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md new file mode 100644 index 000000000..db2ea28a9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ChannelsListResponse + +```ts +type ChannelsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channels? + +```ts +optional channels: Channel[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md new file mode 100644 index 000000000..41c3b2e99 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChannelsMarkResponse + +```ts +type ChannelsMarkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md new file mode 100644 index 000000000..9c5dead13 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsRenameResponse + +```ts +type ChannelsRenameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md new file mode 100644 index 000000000..1c88ba634 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md @@ -0,0 +1,59 @@ +# Type Alias: ChannelsRepliesResponse + +```ts +type ChannelsRepliesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md new file mode 100644 index 000000000..33704363a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsSetPurposeResponse + +```ts +type ChannelsSetPurposeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### purpose? + +```ts +optional purpose: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md new file mode 100644 index 000000000..8b8ca9928 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChannelsSetTopicResponse + +```ts +type ChannelsSetTopicResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### topic? + +```ts +optional topic: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md new file mode 100644 index 000000000..44781d9a5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChannelsUnarchiveResponse + +```ts +type ChannelsUnarchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChannelsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md b/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md new file mode 100644 index 000000000..fae18eb9b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ChatDeleteResponse + +```ts +type ChatDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### ts? + +```ts +optional ts: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md new file mode 100644 index 000000000..9d3f1d9cd --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChatDeleteScheduledMessageResponse + +```ts +type ChatDeleteScheduledMessageResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatDeleteScheduledMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatDeleteScheduledMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md b/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md new file mode 100644 index 000000000..c34195390 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ChatGetPermalinkResponse + +```ts +type ChatGetPermalinkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### permalink? + +```ts +optional permalink: string; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatGetPermalinkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatGetPermalinkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md new file mode 100644 index 000000000..c9cd60270 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ChatMeMessageResponse + +```ts +type ChatMeMessageResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### ts? + +```ts +optional ts: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatMeMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatMeMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md new file mode 100644 index 000000000..c6f43278a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md @@ -0,0 +1,22 @@ +# Type Alias: ChatPostEphemeralArguments + +```ts +type ChatPostEphemeralArguments: TokenOverridable & MessageContents & object & Authorship & Parse & LinkNames & Partial; +``` + +## Type declaration + +### user + +```ts +user: string; +``` + +#### Description + +`id` of the user who will receive the ephemeral message. +The user should be in the channel specified by the `channel` argument. + +## Defined in + +[packages/web-api/src/types/request/chat.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L161) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md new file mode 100644 index 000000000..f0cb7f55a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ChatPostEphemeralResponse + +```ts +type ChatPostEphemeralResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### message\_ts? + +```ts +optional message_ts: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatPostEphemeralResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatPostEphemeralResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md b/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md new file mode 100644 index 000000000..99bfc71a3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md @@ -0,0 +1,21 @@ +# Type Alias: ChatPostMessageArguments + +```ts +type ChatPostMessageArguments: TokenOverridable & MessageContents & ReplyInThread & Authorship & Parse & LinkNames & Metadata & Unfurls & object; +``` + +## Type declaration + +### mrkdwn? + +```ts +optional mrkdwn: boolean; +``` + +#### Description + +Disable Slack markup parsing by setting to `false`. Enabled by default. + +## Defined in + +[packages/web-api/src/types/request/chat.ts:170](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L170) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md new file mode 100644 index 000000000..6fec5604c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md @@ -0,0 +1,71 @@ +# Type Alias: ChatPostMessageResponse + +```ts +type ChatPostMessageResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### deprecated\_argument? + +```ts +optional deprecated_argument: string; +``` + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: string[]; +``` + +### message? + +```ts +optional message: ChatPostMessageResponseMessage; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### ts? + +```ts +optional ts: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatPostMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatPostMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md new file mode 100644 index 000000000..36c4d2a4a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md @@ -0,0 +1,21 @@ +# Type Alias: ChatScheduleMessageArguments + +```ts +type ChatScheduleMessageArguments: TokenOverridable & MessageContents & object & ReplyInThread & Parse & LinkNames & AsUser & Metadata & Unfurls; +``` + +## Type declaration + +### post\_at + +```ts +post_at: string | number; +``` + +#### Description + +Unix EPOCH timestamp of time in future to send the message. + +## Defined in + +[packages/web-api/src/types/request/chat.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L177) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md new file mode 100644 index 000000000..25cac0ad9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md @@ -0,0 +1,65 @@ +# Type Alias: ChatScheduleMessageResponse + +```ts +type ChatScheduleMessageResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### message? + +```ts +optional message: Message; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### post\_at? + +```ts +optional post_at: number; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### scheduled\_message\_id? + +```ts +optional scheduled_message_id: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatScheduleMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md new file mode 100644 index 000000000..c524cb68b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ChatScheduledMessagesListArguments + +```ts +type ChatScheduledMessagesListArguments: OptionalArgument & Partial>; +``` + +## Defined in + +[packages/web-api/src/types/request/chat.ts:183](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L183) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md new file mode 100644 index 000000000..ed7ded8a2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ChatScheduledMessagesListResponse + +```ts +type ChatScheduledMessagesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### scheduled\_messages? + +```ts +optional scheduled_messages: ScheduledMessage[]; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatScheduledMessagesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatScheduledMessagesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md b/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md new file mode 100644 index 000000000..6a021b6da --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md @@ -0,0 +1,68 @@ +# Type Alias: ChatUnfurlArguments + +```ts +type ChatUnfurlArguments: object & UnfurlTarget & TokenOverridable & object; +``` + +## Type declaration + +### unfurls + +```ts +unfurls: LinkUnfurls; +``` + +#### Description + +URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl +blocks or message attachments. + +## Type declaration + +### user\_auth\_blocks? + +```ts +optional user_auth_blocks: (KnownBlock | Block)[]; +``` + +#### Description + +Provide a JSON based array of structured blocks presented as URL-encoded string to send as an +ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. + +### user\_auth\_message? + +```ts +optional user_auth_message: string; +``` + +#### Description + +Provide a simply-formatted string to send as an ephemeral message to the user as invitation to +authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again. + +### user\_auth\_required? + +```ts +optional user_auth_required: boolean; +``` + +#### Description + +Set to `true` to indicate the user must install your Slack app to trigger unfurls for this domain. +Defaults to `false`. + +### user\_auth\_url? + +```ts +optional user_auth_url: string; +``` + +#### Description + +Send users to this custom URL where they will complete authentication in your app to fully trigger +unfurling. Value should be properly URL-encoded. + +## Defined in + +[packages/web-api/src/types/request/chat.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L201) diff --git a/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md b/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md new file mode 100644 index 000000000..d727cd6d9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ChatUnfurlResponse + +```ts +type ChatUnfurlResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatUnfurlResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatUnfurlResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md b/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md new file mode 100644 index 000000000..cabc8f347 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md @@ -0,0 +1,43 @@ +# Type Alias: ChatUpdateArguments + +```ts +type ChatUpdateArguments: MessageContents & object & TokenOverridable & AsUser & LinkNames & Metadata & Parse & object; +``` + +## Type declaration + +### ts + +```ts +ts: string; +``` + +#### Description + +Timestamp of the message to be updated. + +## Type declaration + +### file\_ids? + +```ts +optional file_ids: string[]; +``` + +#### Description + +Array of new file ids that will be sent with this message. + +### reply\_broadcast? + +```ts +optional reply_broadcast: boolean; +``` + +#### Description + +Broadcast an existing thread reply to make it visible to everyone in the channel or conversation. + +## Defined in + +[packages/web-api/src/types/request/chat.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L232) diff --git a/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md b/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md new file mode 100644 index 000000000..1a4505400 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md @@ -0,0 +1,65 @@ +# Type Alias: ChatUpdateResponse + +```ts +type ChatUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### message? + +```ts +optional message: Message; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### text? + +```ts +optional text: string; +``` + +### ts? + +```ts +optional ts: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ChatUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationFilter.md b/docs/content/reference/web-api/type-aliases/ConversationFilter.md new file mode 100644 index 000000000..9c5ac0a93 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationFilter.md @@ -0,0 +1,18 @@ +# Type Alias: ConversationFilter + +```ts +type ConversationFilter: BaseConversationFilter & Required> | BaseConversationFilter & Required> | BaseConversationFilter & Required>; +``` + +## Description + +Defines a filter for the list of options in a conversation selector menu. The menu can be either a +conversations select menu or a conversations multi-select menu. + +## See + +[Conversation filter object reference](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:171 diff --git a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md new file mode 100644 index 000000000..bd6a862b5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md @@ -0,0 +1,32 @@ +# Type Alias: ConversationsAcceptSharedInviteArguments + +```ts +type ConversationsAcceptSharedInviteArguments: TokenOverridable & OptionalTeamAssignable & ChannelID | InviteID & IsPrivate & object; +``` + +## Type declaration + +### channel\_name + +```ts +channel_name: string; +``` + +#### Description + +Name of the channel. If the channel does not exist already in your workspace, +this name is the one that the channel will take. + +### free\_trial\_accepted? + +```ts +optional free_trial_accepted: boolean; +``` + +#### Description + +Whether you'd like to use your workspace's free trial to begin using Slack Connect. + +## Defined in + +[packages/web-api/src/types/request/conversations.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L51) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md new file mode 100644 index 000000000..6ae0e57e8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md @@ -0,0 +1,59 @@ +# Type Alias: ConversationsAcceptSharedInviteResponse + +```ts +type ConversationsAcceptSharedInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### can\_open\_scdm? + +```ts +optional can_open_scdm: boolean; +``` + +### channel\_id? + +```ts +optional channel_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### implicit\_approval? + +```ts +optional implicit_approval: boolean; +``` + +### invite\_id? + +```ts +optional invite_id: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsAcceptSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsAcceptSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md new file mode 100644 index 000000000..547358dfa --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsApproveSharedInviteResponse + +```ts +type ConversationsApproveSharedInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsApproveSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsApproveSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md new file mode 100644 index 000000000..e3f533843 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsArchiveResponse + +```ts +type ConversationsArchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md new file mode 100644 index 000000000..836d76fa2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ConversationsCanvasesCreateResponse + +```ts +type ConversationsCanvasesCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### canvas\_id? + +```ts +optional canvas_id: string; +``` + +### detail? + +```ts +optional detail: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsCanvasesCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCanvasesCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md new file mode 100644 index 000000000..aa10b43e6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ConversationsCloseResponse + +```ts +type ConversationsCloseResponse: WebAPICallResult & object; +``` + +## Type declaration + +### already\_closed? + +```ts +optional already_closed: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### no\_op? + +```ts +optional no_op: boolean; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md new file mode 100644 index 000000000..b04dbac89 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ConversationsCreateResponse + +```ts +type ConversationsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### detail? + +```ts +optional detail: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md new file mode 100644 index 000000000..822184a20 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsDeclineSharedInviteResponse + +```ts +type ConversationsDeclineSharedInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsDeclineSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsDeclineSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md new file mode 100644 index 000000000..a4a5610bf --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsExternalInvitePermissionsSetResponse + +```ts +type ConversationsExternalInvitePermissionsSetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsExternalInvitePermissionsSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsExternalInvitePermissionsSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md new file mode 100644 index 000000000..5e738ec77 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md @@ -0,0 +1,77 @@ +# Type Alias: ConversationsHistoryResponse + +```ts +type ConversationsHistoryResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_actions\_count? + +```ts +optional channel_actions_count: number; +``` + +### channel\_actions\_ts? + +```ts +optional channel_actions_ts: number; +``` + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: MessageElement[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### oldest? + +```ts +optional oldest: string; +``` + +### pin\_count? + +```ts +optional pin_count: number; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md new file mode 100644 index 000000000..78e079a4e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ConversationsInfoResponse + +```ts +type ConversationsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md new file mode 100644 index 000000000..2ad6c673b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ConversationsInviteResponse + +```ts +type ConversationsInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### errors? + +```ts +optional errors: Error[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md new file mode 100644 index 000000000..46eac8716 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md @@ -0,0 +1,21 @@ +# Type Alias: ConversationsInviteSharedArguments + +```ts +type ConversationsInviteSharedArguments: Channel & TokenOverridable & Emails | UserIDs & object; +``` + +## Type declaration + +### external\_limited? + +```ts +optional external_limited: boolean; +``` + +#### Description + +Whether invite is to an external limited member. Defaults to `true`. + +## Defined in + +[packages/web-api/src/types/request/conversations.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L109) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md new file mode 100644 index 000000000..472a2a6c5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md @@ -0,0 +1,59 @@ +# Type Alias: ConversationsInviteSharedResponse + +```ts +type ConversationsInviteSharedResponse: WebAPICallResult & object; +``` + +## Type declaration + +### conf\_code? + +```ts +optional conf_code: string; +``` + +### error? + +```ts +optional error: string; +``` + +### invite\_id? + +```ts +optional invite_id: string; +``` + +### is\_legacy\_shared\_channel? + +```ts +optional is_legacy_shared_channel: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### url? + +```ts +optional url: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsInviteSharedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInviteSharedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md new file mode 100644 index 000000000..180f809cb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ConversationsJoinResponse + +```ts +type ConversationsJoinResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsJoinResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsJoinResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md new file mode 100644 index 000000000..784554e11 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsKickResponse + +```ts +type ConversationsKickResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md new file mode 100644 index 000000000..84382c2bc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsLeaveResponse + +```ts +type ConversationsLeaveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md new file mode 100644 index 000000000..878c95653 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ConversationsListArguments + +```ts +type ConversationsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/conversations.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L126) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md new file mode 100644 index 000000000..d66f8f837 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ConversationsListConnectInvitesArguments + +```ts +type ConversationsListConnectInvitesArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/conversations.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L138) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md new file mode 100644 index 000000000..c49c97063 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ConversationsListConnectInvitesResponse + +```ts +type ConversationsListConnectInvitesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### arg? + +```ts +optional arg: string; +``` + +### error? + +```ts +optional error: string; +``` + +### invites? + +```ts +optional invites: InviteElement[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsListConnectInvitesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsListConnectInvitesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md new file mode 100644 index 000000000..bbd7c0095 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ConversationsListResponse + +```ts +type ConversationsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channels? + +```ts +optional channels: Channel[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md new file mode 100644 index 000000000..675875433 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsMarkResponse + +```ts +type ConversationsMarkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md new file mode 100644 index 000000000..d528ab1e0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ConversationsMembersResponse + +```ts +type ConversationsMembersResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### members? + +```ts +optional members: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsMembersResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsMembersResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md new file mode 100644 index 000000000..36d9912d8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md @@ -0,0 +1,32 @@ +# Type Alias: ConversationsOpenArguments + +```ts +type ConversationsOpenArguments: Channel | Users & TokenOverridable & object; +``` + +## Type declaration + +### prevent\_creation? + +```ts +optional prevent_creation: boolean; +``` + +#### Description + +Do not create a direct message or multi-person direct message. +This is used to see if there is an existing dm or mpdm. + +### return\_im? + +```ts +optional return_im: boolean; +``` + +#### Description + +Indicates you want the full IM channel definition in the response. + +## Defined in + +[packages/web-api/src/types/request/conversations.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L152) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md new file mode 100644 index 000000000..2daf7a20d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ConversationsOpenResponse + +```ts +type ConversationsOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### already\_open? + +```ts +optional already_open: boolean; +``` + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### no\_op? + +```ts +optional no_op: boolean; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md new file mode 100644 index 000000000..540ceee88 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ConversationsRenameResponse + +```ts +type ConversationsRenameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md new file mode 100644 index 000000000..e8747cbdb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ConversationsRepliesResponse + +```ts +type ConversationsRepliesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: MessageElement[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md new file mode 100644 index 000000000..4020a4a25 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ConversationsSetPurposeResponse + +```ts +type ConversationsSetPurposeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md new file mode 100644 index 000000000..108301b8f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md @@ -0,0 +1,41 @@ +# Type Alias: ConversationsSetTopicResponse + +```ts +type ConversationsSetTopicResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md new file mode 100644 index 000000000..f85d65fe1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ConversationsUnarchiveResponse + +```ts +type ConversationsUnarchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ConversationsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md b/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md new file mode 100644 index 000000000..fd4024d36 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md @@ -0,0 +1,47 @@ +# Type Alias: DialogOpenResponse + +```ts +type DialogOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/DialogOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DialogOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md b/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md new file mode 100644 index 000000000..a6eb4a833 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md @@ -0,0 +1,9 @@ +# Type Alias: DndEndDndArguments + +```ts +type DndEndDndArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/dnd.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md b/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md new file mode 100644 index 000000000..bc68cf12a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md @@ -0,0 +1,35 @@ +# Type Alias: DndEndDndResponse + +```ts +type DndEndDndResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/DndEndDndResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndEndDndResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md b/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md new file mode 100644 index 000000000..fc554e46d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md @@ -0,0 +1,9 @@ +# Type Alias: DndEndSnoozeArguments + +```ts +type DndEndSnoozeArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/dnd.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L7) diff --git a/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md b/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md new file mode 100644 index 000000000..3e83859e7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md @@ -0,0 +1,59 @@ +# Type Alias: DndEndSnoozeResponse + +```ts +type DndEndSnoozeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### dnd\_enabled? + +```ts +optional dnd_enabled: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### next\_dnd\_end\_ts? + +```ts +optional next_dnd_end_ts: number; +``` + +### next\_dnd\_start\_ts? + +```ts +optional next_dnd_start_ts: number; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### snooze\_enabled? + +```ts +optional snooze_enabled: boolean; +``` + +## Defined in + +[packages/web-api/src/types/response/DndEndSnoozeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndEndSnoozeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndInfoArguments.md b/docs/content/reference/web-api/type-aliases/DndInfoArguments.md new file mode 100644 index 000000000..b1c75ce1d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: DndInfoArguments + +```ts +type DndInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/dnd.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L9) diff --git a/docs/content/reference/web-api/type-aliases/DndInfoResponse.md b/docs/content/reference/web-api/type-aliases/DndInfoResponse.md new file mode 100644 index 000000000..278bf9cc2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndInfoResponse.md @@ -0,0 +1,53 @@ +# Type Alias: DndInfoResponse + +```ts +type DndInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### dnd\_enabled? + +```ts +optional dnd_enabled: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### next\_dnd\_end\_ts? + +```ts +optional next_dnd_end_ts: number; +``` + +### next\_dnd\_start\_ts? + +```ts +optional next_dnd_start_ts: number; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/DndInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md b/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md new file mode 100644 index 000000000..79715f598 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md @@ -0,0 +1,59 @@ +# Type Alias: DndSetSnoozeResponse + +```ts +type DndSetSnoozeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### snooze\_enabled? + +```ts +optional snooze_enabled: boolean; +``` + +### snooze\_endtime? + +```ts +optional snooze_endtime: number; +``` + +### snooze\_is\_indefinite? + +```ts +optional snooze_is_indefinite: boolean; +``` + +### snooze\_remaining? + +```ts +optional snooze_remaining: number; +``` + +## Defined in + +[packages/web-api/src/types/response/DndSetSnoozeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndSetSnoozeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md b/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md new file mode 100644 index 000000000..3ca6c4301 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md @@ -0,0 +1,45 @@ +# Type Alias: DndTeamInfoResponse + +```ts +type DndTeamInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### users? + +```ts +optional users: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `User` + +## Defined in + +[packages/web-api/src/types/response/DndTeamInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndTeamInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/EmojiListArguments.md b/docs/content/reference/web-api/type-aliases/EmojiListArguments.md new file mode 100644 index 000000000..724f3c14c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/EmojiListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: EmojiListArguments + +```ts +type EmojiListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/emoji.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/emoji.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/EmojiListResponse.md b/docs/content/reference/web-api/type-aliases/EmojiListResponse.md new file mode 100644 index 000000000..058e4b2e7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/EmojiListResponse.md @@ -0,0 +1,63 @@ +# Type Alias: EmojiListResponse + +```ts +type EmojiListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### cache\_ts? + +```ts +optional cache_ts: string; +``` + +### categories? + +```ts +optional categories: Category[]; +``` + +### categories\_version? + +```ts +optional categories_version: string; +``` + +### emoji? + +```ts +optional emoji: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `string` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/EmojiListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/EmojiListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md new file mode 100644 index 000000000..14b7a96b1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesCommentsAddResponse + +```ts +type FilesCommentsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### req\_method? + +```ts +optional req_method: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesCommentsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md new file mode 100644 index 000000000..b6aa5955c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: FilesCommentsDeleteResponse + +```ts +type FilesCommentsDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesCommentsDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md new file mode 100644 index 000000000..112f384f4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesCommentsEditResponse + +```ts +type FilesCommentsEditResponse: WebAPICallResult & object; +``` + +## Type declaration + +### comment? + +```ts +optional comment: Comment; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesCommentsEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md new file mode 100644 index 000000000..e8c559998 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md @@ -0,0 +1,31 @@ +# Type Alias: FilesCompleteUploadExternalArguments + +```ts +type FilesCompleteUploadExternalArguments: FileDestinationArgument & TokenOverridable & object; +``` + +## Type declaration + +### files + +```ts +files: [FileUploadComplete, ...FileUploadComplete[]]; +``` + +#### Description + +Array of file IDs and their corresponding (optional) titles. + +### initial\_comment? + +```ts +optional initial_comment: string; +``` + +#### Description + +The message text introducing the file in the specified channel. + +## Defined in + +[packages/web-api/src/types/request/files.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L65) diff --git a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md new file mode 100644 index 000000000..ff2ac239b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md @@ -0,0 +1,47 @@ +# Type Alias: FilesCompleteUploadExternalResponse + +```ts +type FilesCompleteUploadExternalResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### files? + +```ts +optional files: File[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md b/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md new file mode 100644 index 000000000..0ad5cfbec --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: FilesDeleteResponse + +```ts +type FilesDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md b/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md new file mode 100644 index 000000000..f505e3f90 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md @@ -0,0 +1,53 @@ +# Type Alias: FilesGetUploadURLExternalResponse + +```ts +type FilesGetUploadURLExternalResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file\_id? + +```ts +optional file_id: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### upload\_url? + +```ts +optional upload_url: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesGetUploadURLExternalResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesGetUploadURLExternalResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md b/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md new file mode 100644 index 000000000..88148c40c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md @@ -0,0 +1,83 @@ +# Type Alias: FilesInfoResponse + +```ts +type FilesInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### comments? + +```ts +optional comments: Comment[]; +``` + +### content? + +```ts +optional content: string; +``` + +### content\_highlight\_css? + +```ts +optional content_highlight_css: string; +``` + +### content\_highlight\_html? + +```ts +optional content_highlight_html: string; +``` + +### content\_highlight\_html\_truncated? + +```ts +optional content_highlight_html_truncated: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### is\_truncated? + +```ts +optional is_truncated: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesListResponse.md b/docs/content/reference/web-api/type-aliases/FilesListResponse.md new file mode 100644 index 000000000..d28f85810 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: FilesListResponse + +```ts +type FilesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### files? + +```ts +optional files: File[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md new file mode 100644 index 000000000..697ba2b63 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesRemoteAddResponse + +```ts +type FilesRemoteAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md new file mode 100644 index 000000000..f0925e748 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesRemoteInfoArguments + +```ts +type FilesRemoteInfoArguments: FileOrExternalID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:195](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L195) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md new file mode 100644 index 000000000..2c9c434d7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesRemoteInfoResponse + +```ts +type FilesRemoteInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md new file mode 100644 index 000000000..7299a292c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: FilesRemoteListResponse + +```ts +type FilesRemoteListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### files? + +```ts +optional files: File[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md new file mode 100644 index 000000000..e272f2f5e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesRemoteRemoveArguments + +```ts +type FilesRemoteRemoveArguments: FileOrExternalID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:206](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L206) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md new file mode 100644 index 000000000..80ceedd31 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: FilesRemoteRemoveResponse + +```ts +type FilesRemoteRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md new file mode 100644 index 000000000..e27bdc103 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesRemoteShareArguments + +```ts +type FilesRemoteShareArguments: Required & FileOrExternalID & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L208) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md new file mode 100644 index 000000000..c73cf1beb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesRemoteShareResponse + +```ts +type FilesRemoteShareResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteShareResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteShareResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md new file mode 100644 index 000000000..73e400f5d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesRemoteUpdateArguments + +```ts +type FilesRemoteUpdateArguments: Partial & FileOrExternalID & FileType & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:210](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L210) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md new file mode 100644 index 000000000..7b7cf78ac --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesRemoteUpdateResponse + +```ts +type FilesRemoteUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md b/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md new file mode 100644 index 000000000..dff96549e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesRevokePublicURLResponse + +```ts +type FilesRevokePublicURLResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md b/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md new file mode 100644 index 000000000..4c9887414 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesSharedPublicURLResponse + +```ts +type FilesSharedPublicURLResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md b/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md new file mode 100644 index 000000000..5482c38df --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesUploadArguments + +```ts +type FilesUploadArguments: FileUpload & TokenOverridable; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L140) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md b/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md new file mode 100644 index 000000000..e32fa7191 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md @@ -0,0 +1,41 @@ +# Type Alias: FilesUploadResponse + +```ts +type FilesUploadResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### file? + +```ts +optional file: File; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FilesUploadResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesUploadResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md b/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md new file mode 100644 index 000000000..1f543e0d8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md @@ -0,0 +1,9 @@ +# Type Alias: FilesUploadV2Arguments + +```ts +type FilesUploadV2Arguments: TokenOverridable & FileUploadV2 | Omit & FilesUploadV2ArgumentsMultipleFiles; +``` + +## Defined in + +[packages/web-api/src/types/request/files.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L158) diff --git a/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md b/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md new file mode 100644 index 000000000..70b83a8e8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md @@ -0,0 +1,35 @@ +# Type Alias: FunctionsCompleteErrorResponse + +```ts +type FunctionsCompleteErrorResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FunctionsCompleteErrorResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FunctionsCompleteErrorResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md b/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md new file mode 100644 index 000000000..c96a612f5 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md @@ -0,0 +1,35 @@ +# Type Alias: FunctionsCompleteSuccessResponse + +```ts +type FunctionsCompleteSuccessResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/FunctionsCompleteSuccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FunctionsCompleteSuccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md new file mode 100644 index 000000000..e0905d9be --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md @@ -0,0 +1,47 @@ +# Type Alias: GroupsArchiveResponse + +```ts +type GroupsArchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md new file mode 100644 index 000000000..e121a40cb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md @@ -0,0 +1,35 @@ +# Type Alias: GroupsCloseResponse + +```ts +type GroupsCloseResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md new file mode 100644 index 000000000..00965f805 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsCreateChildResponse + +```ts +type GroupsCreateChildResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group? + +```ts +optional group: Group; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsCreateChildResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCreateChildResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md new file mode 100644 index 000000000..1dee8475b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsCreateResponse + +```ts +type GroupsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group? + +```ts +optional group: Group; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md new file mode 100644 index 000000000..863cd8273 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md @@ -0,0 +1,65 @@ +# Type Alias: GroupsHistoryResponse + +```ts +type GroupsHistoryResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_actions\_count? + +```ts +optional channel_actions_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md b/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md new file mode 100644 index 000000000..2d29dd4f9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsInfoResponse + +```ts +type GroupsInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group? + +```ts +optional group: Group; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md b/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md new file mode 100644 index 000000000..4aa24643c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsInviteResponse + +```ts +type GroupsInviteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group? + +```ts +optional group: Group; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md b/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md new file mode 100644 index 000000000..31ae1f65e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md @@ -0,0 +1,47 @@ +# Type Alias: GroupsKickResponse + +```ts +type GroupsKickResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md new file mode 100644 index 000000000..545959aaf --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md @@ -0,0 +1,47 @@ +# Type Alias: GroupsLeaveResponse + +```ts +type GroupsLeaveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsListResponse.md b/docs/content/reference/web-api/type-aliases/GroupsListResponse.md new file mode 100644 index 000000000..0055569b2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsListResponse + +```ts +type GroupsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### groups? + +```ts +optional groups: Group[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md b/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md new file mode 100644 index 000000000..c83625468 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md @@ -0,0 +1,47 @@ +# Type Alias: GroupsMarkResponse + +```ts +type GroupsMarkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md b/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md new file mode 100644 index 000000000..ffe6b9eef --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md @@ -0,0 +1,59 @@ +# Type Alias: GroupsOpenResponse + +```ts +type GroupsOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### already\_open? + +```ts +optional already_open: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### no\_op? + +```ts +optional no_op: boolean; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md b/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md new file mode 100644 index 000000000..4bf04f4df --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsRenameResponse + +```ts +type GroupsRenameResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md new file mode 100644 index 000000000..237b1e46d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md @@ -0,0 +1,59 @@ +# Type Alias: GroupsRepliesResponse + +```ts +type GroupsRepliesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md new file mode 100644 index 000000000..6f9507d61 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsSetPurposeResponse + +```ts +type GroupsSetPurposeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### purpose? + +```ts +optional purpose: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md new file mode 100644 index 000000000..67c8c6dfa --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md @@ -0,0 +1,53 @@ +# Type Alias: GroupsSetTopicResponse + +```ts +type GroupsSetTopicResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### topic? + +```ts +optional topic: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md new file mode 100644 index 000000000..650dcb2b8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md @@ -0,0 +1,47 @@ +# Type Alias: GroupsUnarchiveResponse + +```ts +type GroupsUnarchiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/GroupsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImCloseResponse.md b/docs/content/reference/web-api/type-aliases/ImCloseResponse.md new file mode 100644 index 000000000..710e4d39d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImCloseResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ImCloseResponse + +```ts +type ImCloseResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md new file mode 100644 index 000000000..9265484f0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md @@ -0,0 +1,65 @@ +# Type Alias: ImHistoryResponse + +```ts +type ImHistoryResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_actions\_count? + +```ts +optional channel_actions_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImListResponse.md b/docs/content/reference/web-api/type-aliases/ImListResponse.md new file mode 100644 index 000000000..83ca433e6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ImListResponse + +```ts +type ImListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### ims? + +```ts +optional ims: Im[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImMarkResponse.md b/docs/content/reference/web-api/type-aliases/ImMarkResponse.md new file mode 100644 index 000000000..34c0ab824 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImMarkResponse.md @@ -0,0 +1,47 @@ +# Type Alias: ImMarkResponse + +```ts +type ImMarkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImOpenResponse.md b/docs/content/reference/web-api/type-aliases/ImOpenResponse.md new file mode 100644 index 000000000..ed29b2ad7 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImOpenResponse.md @@ -0,0 +1,65 @@ +# Type Alias: ImOpenResponse + +```ts +type ImOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### already\_open? + +```ts +optional already_open: boolean; +``` + +### channel? + +```ts +optional channel: Channel; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### no\_op? + +```ts +optional no_op: boolean; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md new file mode 100644 index 000000000..648f7184e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md @@ -0,0 +1,59 @@ +# Type Alias: ImRepliesResponse + +```ts +type ImRepliesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ImRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImageBlock.md b/docs/content/reference/web-api/type-aliases/ImageBlock.md new file mode 100644 index 000000000..ad11fdda3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImageBlock.md @@ -0,0 +1,51 @@ +# Type Alias: ImageBlock + +```ts +type ImageBlock: object & Block & UrlImageObject | SlackFileImageObject; +``` + +## Type declaration + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A plain-text summary of the image. This should not contain any markup. +Maximum length for this field is 2000 characters. + +### title? + +```ts +optional title: PlainTextElement; +``` + +#### Description + +An optional title for the image in the form of a [PlainTextElement](../interfaces/PlainTextElement.md) object. +Maximum length for the text in this field is 2000 characters. + +### type + +```ts +type: "image"; +``` + +#### Description + +The type of block. For an image block, `type` is always `image`. + +## Description + +Displays an image. A simple image block, designed to make those cat photos really pop. + +## See + +[Image block reference](https://api.slack.com/reference/block-kit/blocks#image). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:98 diff --git a/docs/content/reference/web-api/type-aliases/ImageElement.md b/docs/content/reference/web-api/type-aliases/ImageElement.md new file mode 100644 index 000000000..f6ea1688a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ImageElement.md @@ -0,0 +1,40 @@ +# Type Alias: ImageElement + +```ts +type ImageElement: object & UrlImageObject | SlackFileImageObject; +``` + +## Type declaration + +### alt\_text + +```ts +alt_text: string; +``` + +#### Description + +A plain-text summary of the image. This should not contain any markup. + +### type + +```ts +type: "image"; +``` + +#### Description + +The type of element. In this case `type` is always `image`. + +## Description + +Displays an image as part of a larger block of content. Use this `image` block if you want a block with +only an image in it. + +## See + +[Image element reference](https://api.slack.com/reference/block-kit/block-elements#image). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:143 diff --git a/docs/content/reference/web-api/type-aliases/KnownBlock.md b/docs/content/reference/web-api/type-aliases/KnownBlock.md new file mode 100644 index 000000000..8bc6b8290 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/KnownBlock.md @@ -0,0 +1,19 @@ +# Type Alias: KnownBlock + +```ts +type KnownBlock: + | ImageBlock + | ContextBlock + | ActionsBlock + | DividerBlock + | SectionBlock + | InputBlock + | FileBlock + | HeaderBlock + | VideoBlock + | RichTextBlock; +``` + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 diff --git a/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md b/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md new file mode 100644 index 000000000..8a2ed0f72 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md @@ -0,0 +1,69 @@ +# Type Alias: MigrationExchangeResponse + +```ts +type MigrationExchangeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### enterprise\_id? + +```ts +optional enterprise_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### invalid\_user\_ids? + +```ts +optional invalid_user_ids: string[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team\_id? + +```ts +optional team_id: string; +``` + +### user\_id\_map? + +```ts +optional user_id_map: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `string` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MigrationExchangeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MigrationExchangeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md b/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md new file mode 100644 index 000000000..8149cf332 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md @@ -0,0 +1,47 @@ +# Type Alias: MpimCloseResponse + +```ts +type MpimCloseResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md b/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md new file mode 100644 index 000000000..d77868cff --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md @@ -0,0 +1,65 @@ +# Type Alias: MpimHistoryResponse + +```ts +type MpimHistoryResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel\_actions\_count? + +```ts +optional channel_actions_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimListResponse.md b/docs/content/reference/web-api/type-aliases/MpimListResponse.md new file mode 100644 index 000000000..fc751d721 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: MpimListResponse + +```ts +type MpimListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### groups? + +```ts +optional groups: Group[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md b/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md new file mode 100644 index 000000000..8c2c179bb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md @@ -0,0 +1,47 @@ +# Type Alias: MpimMarkResponse + +```ts +type MpimMarkResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md b/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md new file mode 100644 index 000000000..f236a4717 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md @@ -0,0 +1,53 @@ +# Type Alias: MpimOpenResponse + +```ts +type MpimOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### group? + +```ts +optional group: Group; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md b/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md new file mode 100644 index 000000000..106e9d6ec --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md @@ -0,0 +1,59 @@ +# Type Alias: MpimRepliesResponse + +```ts +type MpimRepliesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### has\_more? + +```ts +optional has_more: boolean; +``` + +### messages? + +```ts +optional messages: Message[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/MpimRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MultiSelect.md b/docs/content/reference/web-api/type-aliases/MultiSelect.md new file mode 100644 index 000000000..5b70c07b8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/MultiSelect.md @@ -0,0 +1,28 @@ +# Type Alias: MultiSelect + +```ts +type MultiSelect: + | MultiUsersSelect + | MultiStaticSelect + | MultiConversationsSelect + | MultiChannelsSelect + | MultiExternalSelect; +``` + +## Description + +Allows users to select multiple items from a list of options. +Just like regular [Select](Select.md), multi-select menus also include type-ahead functionality, where a user can type a +part or all of an option string to filter the list. +There are different types of multi-select menu that depend on different data sources for their lists of options: +[MultiStaticSelect](../interfaces/MultiStaticSelect.md), [MultiExternalSelect](../interfaces/MultiExternalSelect.md), [MultiUsersSelect](../interfaces/MultiUsersSelect.md), [MultiConversationsSelect](../interfaces/MultiConversationsSelect.md), +[MultiChannelsSelect](../interfaces/MultiChannelsSelect.md). + +## See + + - [Multi-select menu element reference](https://api.slack.com/reference/block-kit/block-elements#multi_select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:173 diff --git a/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md b/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md new file mode 100644 index 000000000..16ac1841c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md @@ -0,0 +1,113 @@ +# Type Alias: OauthAccessResponse + +```ts +type OauthAccessResponse: WebAPICallResult & object; +``` + +## Type declaration + +### access\_token? + +```ts +optional access_token: string; +``` + +### authorizing\_user? + +```ts +optional authorizing_user: User; +``` + +### bot? + +```ts +optional bot: Bot; +``` + +### enterprise\_id? + +```ts +optional enterprise_id: string; +``` + +### error? + +```ts +optional error: string; +``` + +### incoming\_webhook? + +```ts +optional incoming_webhook: IncomingWebhook; +``` + +### installer\_user? + +```ts +optional installer_user: User; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### scope? + +```ts +optional scope: string; +``` + +### scopes? + +```ts +optional scopes: Scopes; +``` + +### team\_id? + +```ts +optional team_id: string; +``` + +### team\_name? + +```ts +optional team_name: string; +``` + +### token\_type? + +```ts +optional token_type: string; +``` + +### user\_id? + +```ts +optional user_id: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OauthAccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthAccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md b/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md new file mode 100644 index 000000000..b7b8b43e6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md @@ -0,0 +1,41 @@ +# Type Alias: OauthTokenResponse + +```ts +type OauthTokenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### req\_method? + +```ts +optional req_method: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OauthTokenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthTokenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md b/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md new file mode 100644 index 000000000..3b59ab10b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md @@ -0,0 +1,113 @@ +# Type Alias: OauthV2AccessResponse + +```ts +type OauthV2AccessResponse: WebAPICallResult & object; +``` + +## Type declaration + +### access\_token? + +```ts +optional access_token: string; +``` + +### app\_id? + +```ts +optional app_id: string; +``` + +### authed\_user? + +```ts +optional authed_user: AuthedUser; +``` + +### bot\_user\_id? + +```ts +optional bot_user_id: string; +``` + +### enterprise? + +```ts +optional enterprise: Enterprise; +``` + +### error? + +```ts +optional error: string; +``` + +### expires\_in? + +```ts +optional expires_in: number; +``` + +### incoming\_webhook? + +```ts +optional incoming_webhook: IncomingWebhook; +``` + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +### scope? + +```ts +optional scope: string; +``` + +### team? + +```ts +optional team: Enterprise; +``` + +### token\_type? + +```ts +optional token_type: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OauthV2AccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthV2AccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md b/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md new file mode 100644 index 000000000..53ca9d1be --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md @@ -0,0 +1,119 @@ +# Type Alias: OauthV2ExchangeResponse + +```ts +type OauthV2ExchangeResponse: WebAPICallResult & object; +``` + +## Type declaration + +### access\_token? + +```ts +optional access_token: string; +``` + +### app\_id? + +```ts +optional app_id: string; +``` + +### authed\_user? + +```ts +optional authed_user: AuthedUser; +``` + +### bot\_user\_id? + +```ts +optional bot_user_id: string; +``` + +### enterprise? + +```ts +optional enterprise: Enterprise; +``` + +### error? + +```ts +optional error: string; +``` + +### expires\_in? + +```ts +optional expires_in: number; +``` + +### incoming\_webhook? + +```ts +optional incoming_webhook: IncomingWebhook; +``` + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### scope? + +```ts +optional scope: string; +``` + +### team? + +```ts +optional team: Enterprise; +``` + +### token\_type? + +```ts +optional token_type: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OauthV2ExchangeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthV2ExchangeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md new file mode 100644 index 000000000..77f57f102 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md @@ -0,0 +1,71 @@ +# Type Alias: OpenIDConnectTokenResponse + +```ts +type OpenIDConnectTokenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### access\_token? + +```ts +optional access_token: string; +``` + +### error? + +```ts +optional error: string; +``` + +### expires\_in? + +```ts +optional expires_in: number; +``` + +### id\_token? + +```ts +optional id_token: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +### token\_type? + +```ts +optional token_type: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OpenIDConnectTokenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OpenIDConnectTokenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md new file mode 100644 index 000000000..25723df6e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: OpenIDConnectUserInfoArguments + +```ts +type OpenIDConnectUserInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/openid.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/openid.ts#L8) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md new file mode 100644 index 000000000..44b1589ba --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md @@ -0,0 +1,221 @@ +# Type Alias: OpenIDConnectUserInfoResponse + +```ts +type OpenIDConnectUserInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### date\_email\_verified? + +```ts +optional date_email_verified: number; +``` + +### email? + +```ts +optional email: string; +``` + +### email\_verified? + +```ts +optional email_verified: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### family\_name? + +```ts +optional family_name: string; +``` + +### given\_name? + +```ts +optional given_name: string; +``` + +### https://slack.com/enterprise\_domain? + +```ts +optional com/enterprise_domain: string; +``` + +### https://slack.com/enterprise\_id? + +```ts +optional com/enterprise_id: string; +``` + +### https://slack.com/enterprise\_name? + +```ts +optional com/enterprise_name: string; +``` + +### https://slack.com/team\_domain? + +```ts +optional com/team_domain: string; +``` + +### https://slack.com/team\_id? + +```ts +optional com/team_id: string; +``` + +### https://slack.com/team\_image\_102? + +```ts +optional com/team_image_102: string; +``` + +### https://slack.com/team\_image\_132? + +```ts +optional com/team_image_132: string; +``` + +### https://slack.com/team\_image\_230? + +```ts +optional com/team_image_230: string; +``` + +### https://slack.com/team\_image\_34? + +```ts +optional com/team_image_34: string; +``` + +### https://slack.com/team\_image\_44? + +```ts +optional com/team_image_44: string; +``` + +### https://slack.com/team\_image\_68? + +```ts +optional com/team_image_68: string; +``` + +### https://slack.com/team\_image\_88? + +```ts +optional com/team_image_88: string; +``` + +### https://slack.com/team\_name? + +```ts +optional com/team_name: string; +``` + +### https://slack.com/user\_id? + +```ts +optional com/user_id: string; +``` + +### https://slack.com/user\_image\_1024? + +```ts +optional com/user_image_1024: string; +``` + +### https://slack.com/user\_image\_192? + +```ts +optional com/user_image_192: string; +``` + +### https://slack.com/user\_image\_24? + +```ts +optional com/user_image_24: string; +``` + +### https://slack.com/user\_image\_32? + +```ts +optional com/user_image_32: string; +``` + +### https://slack.com/user\_image\_48? + +```ts +optional com/user_image_48: string; +``` + +### https://slack.com/user\_image\_512? + +```ts +optional com/user_image_512: string; +``` + +### https://slack.com/user\_image\_72? + +```ts +optional com/user_image_72: string; +``` + +### locale? + +```ts +optional locale: string; +``` + +### name? + +```ts +optional name: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### picture? + +```ts +optional picture: string; +``` + +### provided? + +```ts +optional provided: string; +``` + +### sub? + +```ts +optional sub: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/OpenIDConnectUserInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OpenIDConnectUserInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/Option.md b/docs/content/reference/web-api/type-aliases/Option.md new file mode 100644 index 000000000..ef8cc3f5a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/Option.md @@ -0,0 +1,18 @@ +# Type Alias: Option + +```ts +type Option: MrkdwnOption | PlainTextOption; +``` + +## Description + +Defines a single item in a number of item selection elements. An object that represents a single +selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu. + +## See + +[Option object reference](https://api.slack.com/reference/block-kit/composition-objects#option). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:92 diff --git a/docs/content/reference/web-api/type-aliases/PageAccumulator.md b/docs/content/reference/web-api/type-aliases/PageAccumulator.md new file mode 100644 index 000000000..b48e73399 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/PageAccumulator.md @@ -0,0 +1,13 @@ +# Type Alias: PageAccumulator\ + +```ts +type PageAccumulator: R extends (accumulator, page, index) => infer A ? A : never; +``` + +## Type Parameters + +• **R** *extends* [`PageReducer`](../interfaces/PageReducer.md) + +## Defined in + +[packages/web-api/src/WebClient.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L117) diff --git a/docs/content/reference/web-api/type-aliases/PinsAddResponse.md b/docs/content/reference/web-api/type-aliases/PinsAddResponse.md new file mode 100644 index 000000000..12c1a47ec --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/PinsAddResponse.md @@ -0,0 +1,35 @@ +# Type Alias: PinsAddResponse + +```ts +type PinsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/PinsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/PinsListResponse.md b/docs/content/reference/web-api/type-aliases/PinsListResponse.md new file mode 100644 index 000000000..f05129962 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/PinsListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: PinsListResponse + +```ts +type PinsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### items? + +```ts +optional items: Item[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/PinsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md new file mode 100644 index 000000000..b3ea6f8e9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: PinsRemoveResponse + +```ts +type PinsRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/PinsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md b/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md new file mode 100644 index 000000000..3f4f222ad --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md @@ -0,0 +1,9 @@ +# Type Alias: RTMConnectArguments + +```ts +type RTMConnectArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/rtm.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/rtm.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/RTMStartArguments.md b/docs/content/reference/web-api/type-aliases/RTMStartArguments.md new file mode 100644 index 000000000..9e7307d78 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RTMStartArguments.md @@ -0,0 +1,9 @@ +# Type Alias: RTMStartArguments + +```ts +type RTMStartArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/rtm.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/rtm.ts#L18) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md new file mode 100644 index 000000000..4dd78996e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ReactionsAddResponse + +```ts +type ReactionsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ReactionsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md new file mode 100644 index 000000000..8f5bfc015 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ReactionsGetArguments + +```ts +type ReactionsGetArguments: ReactionsFull & TokenOverridable & MessageArgument | FileArgument | FileCommentArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/reactions.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L23) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md new file mode 100644 index 000000000..00f6bf24d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ReactionsGetResponse + +```ts +type ReactionsGetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channel? + +```ts +optional channel: string; +``` + +### error? + +```ts +optional error: string; +``` + +### message? + +```ts +optional message: Message; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### type? + +```ts +optional type: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ReactionsGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md new file mode 100644 index 000000000..f5d9d2866 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ReactionsListArguments + +```ts +type ReactionsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/reactions.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L27) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md new file mode 100644 index 000000000..6c9a2cd2d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ReactionsListResponse + +```ts +type ReactionsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### items? + +```ts +optional items: Item[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/ReactionsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md new file mode 100644 index 000000000..a315d2850 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ReactionsRemoveArguments + +```ts +type ReactionsRemoveArguments: TokenOverridable & ReactionName & MessageArgument | FileArgument | FileCommentArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/reactions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L33) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md new file mode 100644 index 000000000..88b0b734c --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: ReactionsRemoveResponse + +```ts +type ReactionsRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ReactionsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md b/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md new file mode 100644 index 000000000..e881c055a --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md @@ -0,0 +1,47 @@ +# Type Alias: RemindersAddResponse + +```ts +type RemindersAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### reminder? + +```ts +optional reminder: Reminder; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/RemindersAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md b/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md new file mode 100644 index 000000000..e5a82ecd1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: RemindersCompleteResponse + +```ts +type RemindersCompleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/RemindersCompleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersCompleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md b/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md new file mode 100644 index 000000000..a55fae960 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md @@ -0,0 +1,35 @@ +# Type Alias: RemindersDeleteResponse + +```ts +type RemindersDeleteResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/RemindersDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md b/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md new file mode 100644 index 000000000..e86f231ef --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: RemindersInfoResponse + +```ts +type RemindersInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### reminder? + +```ts +optional reminder: Reminder; +``` + +## Defined in + +[packages/web-api/src/types/response/RemindersInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersListArguments.md b/docs/content/reference/web-api/type-aliases/RemindersListArguments.md new file mode 100644 index 000000000..1b7437229 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: RemindersListArguments + +```ts +type RemindersListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/reminders.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L55) diff --git a/docs/content/reference/web-api/type-aliases/RemindersListResponse.md b/docs/content/reference/web-api/type-aliases/RemindersListResponse.md new file mode 100644 index 000000000..125c0f936 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RemindersListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: RemindersListResponse + +```ts +type RemindersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### reminders? + +```ts +optional reminders: Reminder[]; +``` + +## Defined in + +[packages/web-api/src/types/response/RemindersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RichTextElement.md b/docs/content/reference/web-api/type-aliases/RichTextElement.md new file mode 100644 index 000000000..16594c8f9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RichTextElement.md @@ -0,0 +1,23 @@ +# Type Alias: RichTextElement + +```ts +type RichTextElement: + | RichTextBroadcastMention + | RichTextColor + | RichTextChannelMention + | RichTextDate + | RichTextEmoji + | RichTextLink + | RichTextTeamMention + | RichTextText + | RichTextUserMention + | RichTextUsergroupMention; +``` + +## Description + +Union of rich text sub-elements for use within rich text blocks. + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:813 diff --git a/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md b/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md new file mode 100644 index 000000000..b66c64f81 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md @@ -0,0 +1,53 @@ +# Type Alias: RtmConnectResponse + +```ts +type RtmConnectResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### self? + +```ts +optional self: Self; +``` + +### team? + +```ts +optional team: Team; +``` + +### url? + +```ts +optional url: string; +``` + +## Defined in + +[packages/web-api/src/types/response/RtmConnectResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RtmConnectResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RtmStartResponse.md b/docs/content/reference/web-api/type-aliases/RtmStartResponse.md new file mode 100644 index 000000000..1ab82f965 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/RtmStartResponse.md @@ -0,0 +1,173 @@ +# Type Alias: RtmStartResponse + +```ts +type RtmStartResponse: WebAPICallResult & object; +``` + +## Type declaration + +### accept\_tos\_url? + +```ts +optional accept_tos_url: string; +``` + +### bots? + +```ts +optional bots: Bot[]; +``` + +### cache\_ts? + +```ts +optional cache_ts: number; +``` + +### cache\_ts\_version? + +```ts +optional cache_ts_version: string; +``` + +### cache\_version? + +```ts +optional cache_version: string; +``` + +### can\_manage\_shared\_channels? + +```ts +optional can_manage_shared_channels: boolean; +``` + +### channels? + +```ts +optional channels: Channel[]; +``` + +### dnd? + +```ts +optional dnd: Dnd; +``` + +### error? + +```ts +optional error: string; +``` + +### groups? + +```ts +optional groups: Group[]; +``` + +### ims? + +```ts +optional ims: Im[]; +``` + +### is\_europe? + +```ts +optional is_europe: boolean; +``` + +### latest\_event\_ts? + +```ts +optional latest_event_ts: string; +``` + +### links? + +```ts +optional links: Links; +``` + +### mobile\_app\_requires\_upgrade? + +```ts +optional mobile_app_requires_upgrade: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### non\_threadable\_channels? + +```ts +optional non_threadable_channels: string[]; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### read\_only\_channels? + +```ts +optional read_only_channels: string[]; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### self? + +```ts +optional self: Self; +``` + +### subteams? + +```ts +optional subteams: Subteams; +``` + +### team? + +```ts +optional team: Team; +``` + +### thread\_only\_channels? + +```ts +optional thread_only_channels: string[]; +``` + +### url? + +```ts +optional url: string; +``` + +### users? + +```ts +optional users: User[]; +``` + +## Defined in + +[packages/web-api/src/types/response/RtmStartResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RtmStartResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchAllResponse.md b/docs/content/reference/web-api/type-aliases/SearchAllResponse.md new file mode 100644 index 000000000..309d99ab3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/SearchAllResponse.md @@ -0,0 +1,59 @@ +# Type Alias: SearchAllResponse + +```ts +type SearchAllResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### files? + +```ts +optional files: Files; +``` + +### messages? + +```ts +optional messages: Messages; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### posts? + +```ts +optional posts: Posts; +``` + +### provided? + +```ts +optional provided: string; +``` + +### query? + +```ts +optional query: string; +``` + +## Defined in + +[packages/web-api/src/types/response/SearchAllResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchAllResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md b/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md new file mode 100644 index 000000000..e6b895fb1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md @@ -0,0 +1,47 @@ +# Type Alias: SearchFilesResponse + +```ts +type SearchFilesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### files? + +```ts +optional files: Files; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### query? + +```ts +optional query: string; +``` + +## Defined in + +[packages/web-api/src/types/response/SearchFilesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchFilesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md b/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md new file mode 100644 index 000000000..fc42e4624 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md @@ -0,0 +1,47 @@ +# Type Alias: SearchMessagesResponse + +```ts +type SearchMessagesResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### messages? + +```ts +optional messages: Messages; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### query? + +```ts +optional query: string; +``` + +## Defined in + +[packages/web-api/src/types/response/SearchMessagesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchMessagesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/Select.md b/docs/content/reference/web-api/type-aliases/Select.md new file mode 100644 index 000000000..9fa9f82d8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/Select.md @@ -0,0 +1,27 @@ +# Type Alias: Select + +```ts +type Select: + | UsersSelect + | StaticSelect + | ConversationsSelect + | ChannelsSelect + | ExternalSelect; +``` + +## Description + +Allows users to choose an option from a drop down menu. +The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to +filter the list. There are different types of select menu elements that depend on different data sources for their +lists of options: [StaticSelect](../interfaces/StaticSelect.md), [ExternalSelect](../interfaces/ExternalSelect.md), [UsersSelect](../interfaces/UsersSelect.md), [ConversationsSelect](../interfaces/ConversationsSelect.md), +[ChannelsSelect](../interfaces/ChannelsSelect.md). + +## See + + - [Select menu element reference](https://api.slack.com/reference/block-kit/block-elements#select). + - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:162 diff --git a/docs/content/reference/web-api/type-aliases/SlackFile.md b/docs/content/reference/web-api/type-aliases/SlackFile.md new file mode 100644 index 000000000..4fa63759e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/SlackFile.md @@ -0,0 +1,20 @@ +# Type Alias: SlackFile + +```ts +type SlackFile: SlackFileViaUrl | SlackFileViaId; +``` + +## Description + +Defines an object containing Slack file information to be used in an image block or image element. +This file https://api.slack.com/types/file must be an image and you must provide either the URL or ID. In addition, +the user posting these blocks must have access to this file. If both are provided then the payload will be rejected. +Currently only `png`, `jpg`, `jpeg`, and `gif` Slack image files are supported. + +## See + +[Slack File object reference](https://api.slack.com/reference/block-kit/composition-objects#slack_file). + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:209 diff --git a/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md b/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md new file mode 100644 index 000000000..df1f859aa --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md @@ -0,0 +1,9 @@ +# Type Alias: StarsAddRemoveArguments + +```ts +type StarsAddRemoveArguments: TokenOverridable & StarsChannelDestination | MessageArgument | FileArgument | FileCommentArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/stars.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/stars.ts#L17) diff --git a/docs/content/reference/web-api/type-aliases/StarsAddResponse.md b/docs/content/reference/web-api/type-aliases/StarsAddResponse.md new file mode 100644 index 000000000..4a5f9a591 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/StarsAddResponse.md @@ -0,0 +1,35 @@ +# Type Alias: StarsAddResponse + +```ts +type StarsAddResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/StarsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/StarsListResponse.md b/docs/content/reference/web-api/type-aliases/StarsListResponse.md new file mode 100644 index 000000000..029e8d0c2 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/StarsListResponse.md @@ -0,0 +1,47 @@ +# Type Alias: StarsListResponse + +```ts +type StarsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### items? + +```ts +optional items: Item[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/StarsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md new file mode 100644 index 000000000..6d2e595a8 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: StarsRemoveResponse + +```ts +type StarsRemoveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/StarsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TLSOptions.md b/docs/content/reference/web-api/type-aliases/TLSOptions.md new file mode 100644 index 000000000..06e8d8a80 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TLSOptions.md @@ -0,0 +1,14 @@ +# Type Alias: TLSOptions + +```ts +type TLSOptions: Pick; +``` + +## Defined in + +[packages/web-api/src/WebClient.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L83) diff --git a/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md b/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md new file mode 100644 index 000000000..116c8674d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamAccessLogsArguments + +```ts +type TeamAccessLogsArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L13) diff --git a/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md b/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md new file mode 100644 index 000000000..7e6209419 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md @@ -0,0 +1,53 @@ +# Type Alias: TeamAccessLogsResponse + +```ts +type TeamAccessLogsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### logins? + +```ts +optional logins: Login[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamAccessLogsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamAccessLogsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md new file mode 100644 index 000000000..18bdf3a2e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamBillableInfoArguments + +```ts +type TeamBillableInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L22) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md new file mode 100644 index 000000000..96a88d673 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md @@ -0,0 +1,51 @@ +# Type Alias: TeamBillableInfoResponse + +```ts +type TeamBillableInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### billable\_info? + +```ts +optional billable_info: object; +``` + +#### Index Signature + + \[`key`: `string`\]: `BillableInfo` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamBillableInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamBillableInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md new file mode 100644 index 000000000..6904e695b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamBillingInfoArguments + +```ts +type TeamBillingInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L28) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md new file mode 100644 index 000000000..cffda0fbb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: TeamBillingInfoResponse + +```ts +type TeamBillingInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### plan? + +```ts +optional plan: string; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamBillingInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamBillingInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md new file mode 100644 index 000000000..ff39a3994 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamExternalTeamsDisconnectArguments + +```ts +type TeamExternalTeamsDisconnectArguments: TokenOverridable & Required; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L30) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md new file mode 100644 index 000000000..7e8ec3124 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md @@ -0,0 +1,41 @@ +# Type Alias: TeamExternalTeamsDisconnectResponse + +```ts +type TeamExternalTeamsDisconnectResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamExternalTeamsDisconnectResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamExternalTeamsDisconnectResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md new file mode 100644 index 000000000..802747345 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamExternalTeamsListArguments + +```ts +type TeamExternalTeamsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L32) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md new file mode 100644 index 000000000..3f414a5f3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md @@ -0,0 +1,53 @@ +# Type Alias: TeamExternalTeamsListResponse + +```ts +type TeamExternalTeamsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### organizations? + +```ts +optional organizations: Organization[]; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### total\_count? + +```ts +optional total_count: number; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamExternalTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamExternalTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md new file mode 100644 index 000000000..5016a0b8e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamInfoArguments + +```ts +type TeamInfoArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L45) diff --git a/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md new file mode 100644 index 000000000..c9ce95785 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: TeamInfoResponse + +```ts +type TeamInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team? + +```ts +optional team: Team; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md new file mode 100644 index 000000000..7e234f4ad --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamIntegrationLogsArguments + +```ts +type TeamIntegrationLogsArguments: OptionalArgument & TokenOverridable & OptionalTeamAssignable & TraditionalPagingEnabled & object>; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L56) diff --git a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md new file mode 100644 index 000000000..3cbacaf42 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md @@ -0,0 +1,47 @@ +# Type Alias: TeamIntegrationLogsResponse + +```ts +type TeamIntegrationLogsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### logs? + +```ts +optional logs: Log[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### paging? + +```ts +optional paging: Paging; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamIntegrationLogsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamIntegrationLogsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md b/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md new file mode 100644 index 000000000..173cda76e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamPreferencesListArguments + +```ts +type TeamPreferencesListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L71) diff --git a/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md b/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md new file mode 100644 index 000000000..2fe618a9f --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md @@ -0,0 +1,65 @@ +# Type Alias: TeamPreferencesListResponse + +```ts +type TeamPreferencesListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### allow\_message\_deletion? + +```ts +optional allow_message_deletion: boolean; +``` + +### disable\_file\_uploads? + +```ts +optional disable_file_uploads: string; +``` + +### display\_real\_names? + +```ts +optional display_real_names: boolean; +``` + +### error? + +```ts +optional error: string; +``` + +### msg\_edit\_window\_mins? + +```ts +optional msg_edit_window_mins: number; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### who\_can\_post\_general? + +```ts +optional who_can_post_general: string; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamPreferencesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamPreferencesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md b/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md new file mode 100644 index 000000000..80cee1be9 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md @@ -0,0 +1,9 @@ +# Type Alias: TeamProfileGetArguments + +```ts +type TeamProfileGetArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/team.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L66) diff --git a/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md b/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md new file mode 100644 index 000000000..0dd55405d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md @@ -0,0 +1,41 @@ +# Type Alias: TeamProfileGetResponse + +```ts +type TeamProfileGetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### profile? + +```ts +optional profile: Profile; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/TeamProfileGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamProfileGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md b/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md new file mode 100644 index 000000000..936601008 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md @@ -0,0 +1,77 @@ +# Type Alias: ToolingTokensRotateResponse + +```ts +type ToolingTokensRotateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### exp? + +```ts +optional exp: number; +``` + +### iat? + +```ts +optional iat: number; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### refresh\_token? + +```ts +optional refresh_token: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### team\_id? + +```ts +optional team_id: string; +``` + +### token? + +```ts +optional token: string; +``` + +### user\_id? + +```ts +optional user_id: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ToolingTokensRotateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ToolingTokensRotateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md new file mode 100644 index 000000000..9ba8e02b6 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsCreateResponse + +```ts +type UsergroupsCreateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroup? + +```ts +optional usergroup: Usergroup; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md new file mode 100644 index 000000000..827a6ef86 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsDisableResponse + +```ts +type UsergroupsDisableResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroup? + +```ts +optional usergroup: Usergroup; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsDisableResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsDisableResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md new file mode 100644 index 000000000..c162e829b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsEnableResponse + +```ts +type UsergroupsEnableResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroup? + +```ts +optional usergroup: Usergroup; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsEnableResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsEnableResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md b/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md new file mode 100644 index 000000000..ea51d8d2e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md @@ -0,0 +1,9 @@ +# Type Alias: UsergroupsListArguments + +```ts +type UsergroupsListArguments: OptionalArgument; +``` + +## Defined in + +[packages/web-api/src/types/request/usergroups.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L31) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md new file mode 100644 index 000000000..e9169e66d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsListResponse + +```ts +type UsergroupsListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroups? + +```ts +optional usergroups: Usergroup[]; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md new file mode 100644 index 000000000..e3129a769 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsUpdateResponse + +```ts +type UsergroupsUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroup? + +```ts +optional usergroup: Usergroup; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md new file mode 100644 index 000000000..e943d8dc3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsUsersListResponse + +```ts +type UsergroupsUsersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### users? + +```ts +optional users: string[]; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md new file mode 100644 index 000000000..6d89e191b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsergroupsUsersUpdateResponse + +```ts +type UsergroupsUsersUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### usergroup? + +```ts +optional usergroup: Usergroup; +``` + +## Defined in + +[packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md b/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md new file mode 100644 index 000000000..c4b464179 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md @@ -0,0 +1,47 @@ +# Type Alias: UsersConversationsResponse + +```ts +type UsersConversationsResponse: WebAPICallResult & object; +``` + +## Type declaration + +### channels? + +```ts +optional channels: Channel[]; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersConversationsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersConversationsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md b/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md new file mode 100644 index 000000000..d0cab923d --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md @@ -0,0 +1,35 @@ +# Type Alias: UsersDeletePhotoResponse + +```ts +type UsersDeletePhotoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersDeletePhotoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersDeletePhotoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md b/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md new file mode 100644 index 000000000..61351f8a3 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md @@ -0,0 +1,47 @@ +# Type Alias: UsersDiscoverableContactsLookupResponse + +```ts +type UsersDiscoverableContactsLookupResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### is\_discoverable? + +```ts +optional is_discoverable: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersDiscoverableContactsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersDiscoverableContactsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md b/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md new file mode 100644 index 000000000..e79841a28 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md @@ -0,0 +1,77 @@ +# Type Alias: UsersGetPresenceResponse + +```ts +type UsersGetPresenceResponse: WebAPICallResult & object; +``` + +## Type declaration + +### auto\_away? + +```ts +optional auto_away: boolean; +``` + +### connection\_count? + +```ts +optional connection_count: number; +``` + +### error? + +```ts +optional error: string; +``` + +### last\_activity? + +```ts +optional last_activity: number; +``` + +### manual\_away? + +```ts +optional manual_away: boolean; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### online? + +```ts +optional online: boolean; +``` + +### presence? + +```ts +optional presence: string; +``` + +### provided? + +```ts +optional provided: string; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersGetPresenceResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersGetPresenceResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md b/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md new file mode 100644 index 000000000..0190fb410 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md @@ -0,0 +1,53 @@ +# Type Alias: UsersIdentityResponse + +```ts +type UsersIdentityResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### team? + +```ts +optional team: Team; +``` + +### user? + +```ts +optional user: User; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersIdentityResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersIdentityResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md b/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md new file mode 100644 index 000000000..3eeb947bc --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsersInfoResponse + +```ts +type UsersInfoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### user? + +```ts +optional user: User; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersListResponse.md b/docs/content/reference/web-api/type-aliases/UsersListResponse.md new file mode 100644 index 000000000..41b20f956 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersListResponse.md @@ -0,0 +1,65 @@ +# Type Alias: UsersListResponse + +```ts +type UsersListResponse: WebAPICallResult & object; +``` + +## Type declaration + +### arg? + +```ts +optional arg: string; +``` + +### cache\_ts? + +```ts +optional cache_ts: number; +``` + +### error? + +```ts +optional error: string; +``` + +### members? + +```ts +optional members: Member[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### offset? + +```ts +optional offset: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md b/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md new file mode 100644 index 000000000..7e479f675 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md @@ -0,0 +1,47 @@ +# Type Alias: UsersLookupByEmailResponse + +```ts +type UsersLookupByEmailResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### user? + +```ts +optional user: User; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersLookupByEmailResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersLookupByEmailResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md b/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md new file mode 100644 index 000000000..21621c850 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsersProfileGetResponse + +```ts +type UsersProfileGetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### profile? + +```ts +optional profile: Profile; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersProfileGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersProfileGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md b/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md new file mode 100644 index 000000000..d75f43448 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md @@ -0,0 +1,47 @@ +# Type Alias: UsersProfileSetResponse + +```ts +type UsersProfileSetResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### profile? + +```ts +optional profile: Profile; +``` + +### provided? + +```ts +optional provided: string; +``` + +### username? + +```ts +optional username: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersProfileSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersProfileSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md new file mode 100644 index 000000000..eb554592b --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md @@ -0,0 +1,35 @@ +# Type Alias: UsersSetActiveResponse + +```ts +type UsersSetActiveResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersSetActiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetActiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md new file mode 100644 index 000000000..a91c37429 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md @@ -0,0 +1,41 @@ +# Type Alias: UsersSetPhotoResponse + +```ts +type UsersSetPhotoResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### profile? + +```ts +optional profile: Profile; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersSetPhotoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetPhotoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md new file mode 100644 index 000000000..610af9661 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md @@ -0,0 +1,35 @@ +# Type Alias: UsersSetPresenceResponse + +```ts +type UsersSetPresenceResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/UsersSetPresenceResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetPresenceResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/View.md b/docs/content/reference/web-api/type-aliases/View.md new file mode 100644 index 000000000..c0dcc9f80 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/View.md @@ -0,0 +1,9 @@ +# Type Alias: View + +```ts +type View: HomeView | ModalView | WorkflowStepView; +``` + +## Defined in + +packages/web-api/node\_modules/@slack/types/dist/views.d.ts:34 diff --git a/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md b/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md new file mode 100644 index 000000000..969de1cfa --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ViewsOpenArguments + +```ts +type ViewsOpenArguments: BaseViewsArguments & TokenOverridable & ViewTriggerId | ViewInteractivityPointer; +``` + +## Defined in + +[packages/web-api/src/types/request/views.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L26) diff --git a/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md b/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md new file mode 100644 index 000000000..006101f74 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ViewsOpenResponse + +```ts +type ViewsOpenResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### view? + +```ts +optional view: View; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ViewsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md b/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md new file mode 100644 index 000000000..1c5860fa4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ViewsPublishResponse + +```ts +type ViewsPublishResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### view? + +```ts +optional view: View; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ViewsPublishResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsPublishResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md b/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md new file mode 100644 index 000000000..910ee694e --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ViewsPushArguments + +```ts +type ViewsPushArguments: BaseViewsArguments & TokenOverridable & ViewTriggerId | ViewInteractivityPointer; +``` + +## Defined in + +[packages/web-api/src/types/request/views.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md b/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md new file mode 100644 index 000000000..a61941d52 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ViewsPushResponse + +```ts +type ViewsPushResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### view? + +```ts +optional view: View; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ViewsPushResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsPushResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md b/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md new file mode 100644 index 000000000..bc6ab96f4 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md @@ -0,0 +1,9 @@ +# Type Alias: ViewsUpdateArguments + +```ts +type ViewsUpdateArguments: BaseViewsArguments & TokenOverridable & ViewExternalId | ViewViewId & ViewHash; +``` + +## Defined in + +[packages/web-api/src/types/request/views.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L60) diff --git a/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md new file mode 100644 index 000000000..ee0b16dda --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md @@ -0,0 +1,53 @@ +# Type Alias: ViewsUpdateResponse + +```ts +type ViewsUpdateResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: ResponseMetadata; +``` + +### view? + +```ts +optional view: View; +``` + +### warning? + +```ts +optional warning: string; +``` + +## Defined in + +[packages/web-api/src/types/response/ViewsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WebAPICallError.md b/docs/content/reference/web-api/type-aliases/WebAPICallError.md new file mode 100644 index 000000000..cf7e1bbeb --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/WebAPICallError.md @@ -0,0 +1,9 @@ +# Type Alias: WebAPICallError + +```ts +type WebAPICallError: WebAPIPlatformError | WebAPIRequestError | WebAPIHTTPError | WebAPIRateLimitedError; +``` + +## Defined in + +[packages/web-api/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md new file mode 100644 index 000000000..0cfafbb22 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md @@ -0,0 +1,35 @@ +# Type Alias: WorkflowsStepCompletedResponse + +```ts +type WorkflowsStepCompletedResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/WorkflowsStepCompletedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsStepCompletedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md new file mode 100644 index 000000000..eddde48a1 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md @@ -0,0 +1,35 @@ +# Type Alias: WorkflowsStepFailedResponse + +```ts +type WorkflowsStepFailedResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/WorkflowsStepFailedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsStepFailedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md new file mode 100644 index 000000000..486d3c3e0 --- /dev/null +++ b/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md @@ -0,0 +1,35 @@ +# Type Alias: WorkflowsUpdateStepResponse + +```ts +type WorkflowsUpdateStepResponse: WebAPICallResult & object; +``` + +## Type declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +## Defined in + +[packages/web-api/src/types/response/WorkflowsUpdateStepResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsUpdateStepResponse.ts#L12) diff --git a/docs/content/reference/web-api/typedoc-sidebar.cjs b/docs/content/reference/web-api/typedoc-sidebar.cjs new file mode 100644 index 000000000..951c07f12 --- /dev/null +++ b/docs/content/reference/web-api/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/web-api/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/web-api/enumerations/LogLevel","label":"LogLevel"},{"type":"doc","id":"reference/web-api/enumerations/WebClientEvent","label":"WebClientEvent"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/web-api/classes/Methods","label":"Methods"},{"type":"doc","id":"reference/web-api/classes/WebClient","label":"WebClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/web-api/interfaces/Action","label":"Action"},{"type":"doc","id":"reference/web-api/interfaces/Actionable","label":"Actionable"},{"type":"doc","id":"reference/web-api/interfaces/ActionsBlock","label":"ActionsBlock"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsMemberDetails","label":"AdminAnalyticsMemberDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails","label":"AdminAnalyticsPublicChannelDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails","label":"AdminAnalyticsPublicChannelMetadataDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAppsConfigLookupArguments","label":"AdminAppsConfigLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAppsConfigSetArguments","label":"AdminAppsConfigSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments","label":"AdminAuthPolicyAssignEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments","label":"AdminAuthPolicyGetEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments","label":"AdminAuthPolicyRemoveEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersCreateArguments","label":"AdminBarriersCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersDeleteArguments","label":"AdminBarriersDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersUpdateArguments","label":"AdminBarriersUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsArchiveArguments","label":"AdminConversationsArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkArchiveArguments","label":"AdminConversationsBulkArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkDeleteArguments","label":"AdminConversationsBulkDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkMoveArguments","label":"AdminConversationsBulkMoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments","label":"AdminConversationsConvertToPrivateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsConvertToPublicArguments","label":"AdminConversationsConvertToPublicArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsDeleteArguments","label":"AdminConversationsDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments","label":"AdminConversationsDisconnectSharedArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments","label":"AdminConversationsGetConversationPrefsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments","label":"AdminConversationsGetCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetTeamsArguments","label":"AdminConversationsGetTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsInviteArguments","label":"AdminConversationsInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsLookupArguments","label":"AdminConversationsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments","label":"AdminConversationsRemoveCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRenameArguments","label":"AdminConversationsRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments","label":"AdminConversationsRestrictAccessAddGroupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments","label":"AdminConversationsRestrictAccessListGroupsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments","label":"AdminConversationsRestrictAccessRemoveGroupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments","label":"AdminConversationsSetConversationPrefsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments","label":"AdminConversationsSetCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetTeamsArguments","label":"AdminConversationsSetTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsUnarchiveArguments","label":"AdminConversationsUnarchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiAddAliasArguments","label":"AdminEmojiAddAliasArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiAddArguments","label":"AdminEmojiAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiRemoveArguments","label":"AdminEmojiRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiRenameArguments","label":"AdminEmojiRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsListArguments","label":"AdminFunctionsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments","label":"AdminFunctionsPermissionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments","label":"AdminFunctionsPermissionsSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsApproveArguments","label":"AdminInviteRequestsApproveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments","label":"AdminInviteRequestsApprovedListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments","label":"AdminInviteRequestsDeniedListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsDenyArguments","label":"AdminInviteRequestsDenyArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsListArguments","label":"AdminInviteRequestsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminRolesAddAssignmentsArguments","label":"AdminRolesAddAssignmentsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments","label":"AdminRolesRemoveAssignmentsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsAdminsListArguments","label":"AdminTeamsAdminsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsCreateArguments","label":"AdminTeamsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsOwnersListArguments","label":"AdminTeamsOwnersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsInfoArguments","label":"AdminTeamsSettingsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments","label":"AdminTeamsSettingsSetDefaultChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments","label":"AdminTeamsSettingsSetDescriptionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments","label":"AdminTeamsSettingsSetDiscoverabilityArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments","label":"AdminTeamsSettingsSetIconArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments","label":"AdminTeamsSettingsSetNameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments","label":"AdminUsergroupsAddChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments","label":"AdminUsergroupsAddTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsListChannelsArguments","label":"AdminUsergroupsListChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments","label":"AdminUsergroupsRemoveChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersAssignArguments","label":"AdminUsersAssignArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersInviteArguments","label":"AdminUsersInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersRemoveArguments","label":"AdminUsersRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments","label":"AdminUsersSessionClearSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments","label":"AdminUsersSessionGetSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionInvalidateArguments","label":"AdminUsersSessionInvalidateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionResetArguments","label":"AdminUsersSessionResetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionResetBulkArguments","label":"AdminUsersSessionResetBulkArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments","label":"AdminUsersSessionSetSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetAdminArguments","label":"AdminUsersSetAdminArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetExpirationArguments","label":"AdminUsersSetExpirationArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetOwnerArguments","label":"AdminUsersSetOwnerArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetRegularArguments","label":"AdminUsersSetRegularArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments","label":"AdminUsersUnsupportedVersionsExportArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments","label":"AdminWorkflowsCollaboratorsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments","label":"AdminWorkflowsCollaboratorsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments","label":"AdminWorkflowsPermissionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsUnpublishArguments","label":"AdminWorkflowsUnpublishArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsEventAuthorizationsListArguments","label":"AppsEventAuthorizationsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestCreateArguments","label":"AppsManifestCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestDeleteArguments","label":"AppsManifestDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestExportArguments","label":"AppsManifestExportArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestUpdateArguments","label":"AppsManifestUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestValidateArguments","label":"AppsManifestValidateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsUninstallArguments","label":"AppsUninstallArguments"},{"type":"doc","id":"reference/web-api/interfaces/AttachmentAction","label":"AttachmentAction"},{"type":"doc","id":"reference/web-api/interfaces/Block","label":"Block"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksAddArguments","label":"BookmarksAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksEditArguments","label":"BookmarksEditArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksListArguments","label":"BookmarksListArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksRemoveArguments","label":"BookmarksRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/Button","label":"Button"},{"type":"doc","id":"reference/web-api/interfaces/CallUserExternal","label":"CallUserExternal"},{"type":"doc","id":"reference/web-api/interfaces/CallUserSlack","label":"CallUserSlack"},{"type":"doc","id":"reference/web-api/interfaces/CallsAddArguments","label":"CallsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsEndArguments","label":"CallsEndArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsInfoArguments","label":"CallsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsParticipantsAddArguments","label":"CallsParticipantsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsParticipantsRemoveArguments","label":"CallsParticipantsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsUpdateArguments","label":"CallsUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesAccessDeleteArguments","label":"CanvasesAccessDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesAccessSetArguments","label":"CanvasesAccessSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesDeleteArguments","label":"CanvasesDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesEditArguments","label":"CanvasesEditArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesSectionsLookupArguments","label":"CanvasesSectionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChannelsSelect","label":"ChannelsSelect"},{"type":"doc","id":"reference/web-api/interfaces/ChatDeleteArguments","label":"ChatDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatDeleteScheduledMessageArguments","label":"ChatDeleteScheduledMessageArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatGetPermalinkArguments","label":"ChatGetPermalinkArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatMeMessageArguments","label":"ChatMeMessageArguments"},{"type":"doc","id":"reference/web-api/interfaces/Checkboxes","label":"Checkboxes"},{"type":"doc","id":"reference/web-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/web-api/interfaces/Confirm","label":"Confirm"},{"type":"doc","id":"reference/web-api/interfaces/Confirmable","label":"Confirmable"},{"type":"doc","id":"reference/web-api/interfaces/Confirmation","label":"Confirmation"},{"type":"doc","id":"reference/web-api/interfaces/ConfirmationDialog","label":"ConfirmationDialog"},{"type":"doc","id":"reference/web-api/interfaces/ContextBlock","label":"ContextBlock"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsApproveSharedInviteArguments","label":"ConversationsApproveSharedInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsArchiveArguments","label":"ConversationsArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCanvasesCreateArguments","label":"ConversationsCanvasesCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCloseArguments","label":"ConversationsCloseArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCreateArguments","label":"ConversationsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments","label":"ConversationsDeclineSharedInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments","label":"ConversationsExternalInvitePermissionsSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsHistoryArguments","label":"ConversationsHistoryArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsInfoArguments","label":"ConversationsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsInviteArguments","label":"ConversationsInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsJoinArguments","label":"ConversationsJoinArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsKickArguments","label":"ConversationsKickArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsLeaveArguments","label":"ConversationsLeaveArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsMarkArguments","label":"ConversationsMarkArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsMembersArguments","label":"ConversationsMembersArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsRenameArguments","label":"ConversationsRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsRepliesArguments","label":"ConversationsRepliesArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSelect","label":"ConversationsSelect"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSetPurposeArguments","label":"ConversationsSetPurposeArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSetTopicArguments","label":"ConversationsSetTopicArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsUnarchiveArguments","label":"ConversationsUnarchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/DateTimepicker","label":"DateTimepicker"},{"type":"doc","id":"reference/web-api/interfaces/Datepicker","label":"Datepicker"},{"type":"doc","id":"reference/web-api/interfaces/Dialog","label":"Dialog"},{"type":"doc","id":"reference/web-api/interfaces/DialogOpenArguments","label":"DialogOpenArguments"},{"type":"doc","id":"reference/web-api/interfaces/DispatchActionConfig","label":"DispatchActionConfig"},{"type":"doc","id":"reference/web-api/interfaces/Dispatchable","label":"Dispatchable"},{"type":"doc","id":"reference/web-api/interfaces/DividerBlock","label":"DividerBlock"},{"type":"doc","id":"reference/web-api/interfaces/DndSetSnoozeArguments","label":"DndSetSnoozeArguments"},{"type":"doc","id":"reference/web-api/interfaces/DndTeamInfoArguments","label":"DndTeamInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/EmailInput","label":"EmailInput"},{"type":"doc","id":"reference/web-api/interfaces/ExternalSelect","label":"ExternalSelect"},{"type":"doc","id":"reference/web-api/interfaces/FileBlock","label":"FileBlock"},{"type":"doc","id":"reference/web-api/interfaces/FileInput","label":"FileInput"},{"type":"doc","id":"reference/web-api/interfaces/FilesCommentsDeleteArguments","label":"FilesCommentsDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesDeleteArguments","label":"FilesDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesGetUploadURLExternalArguments","label":"FilesGetUploadURLExternalArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesInfoArguments","label":"FilesInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesListArguments","label":"FilesListArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRemoteAddArguments","label":"FilesRemoteAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRemoteListArguments","label":"FilesRemoteListArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRevokePublicURLArguments","label":"FilesRevokePublicURLArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesSharedPublicURLArguments","label":"FilesSharedPublicURLArguments"},{"type":"doc","id":"reference/web-api/interfaces/Focusable","label":"Focusable"},{"type":"doc","id":"reference/web-api/interfaces/FunctionsCompleteErrorArguments","label":"FunctionsCompleteErrorArguments"},{"type":"doc","id":"reference/web-api/interfaces/FunctionsCompleteSuccessArguments","label":"FunctionsCompleteSuccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/HeaderBlock","label":"HeaderBlock"},{"type":"doc","id":"reference/web-api/interfaces/HomeView","label":"HomeView"},{"type":"doc","id":"reference/web-api/interfaces/InputBlock","label":"InputBlock"},{"type":"doc","id":"reference/web-api/interfaces/LinkUnfurls","label":"LinkUnfurls"},{"type":"doc","id":"reference/web-api/interfaces/Logger","label":"Logger"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachment","label":"MessageAttachment"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachmentField","label":"MessageAttachmentField"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachmentPreview","label":"MessageAttachmentPreview"},{"type":"doc","id":"reference/web-api/interfaces/MessageMetadata","label":"MessageMetadata"},{"type":"doc","id":"reference/web-api/interfaces/MessageMetadataEventPayloadObject","label":"MessageMetadataEventPayloadObject"},{"type":"doc","id":"reference/web-api/interfaces/Method","label":"Method"},{"type":"doc","id":"reference/web-api/interfaces/MigrationExchangeArguments","label":"MigrationExchangeArguments"},{"type":"doc","id":"reference/web-api/interfaces/ModalView","label":"ModalView"},{"type":"doc","id":"reference/web-api/interfaces/MrkdwnElement","label":"MrkdwnElement"},{"type":"doc","id":"reference/web-api/interfaces/MrkdwnOption","label":"MrkdwnOption"},{"type":"doc","id":"reference/web-api/interfaces/MultiChannelsSelect","label":"MultiChannelsSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiConversationsSelect","label":"MultiConversationsSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiExternalSelect","label":"MultiExternalSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiStaticSelect","label":"MultiStaticSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiUsersSelect","label":"MultiUsersSelect"},{"type":"doc","id":"reference/web-api/interfaces/NumberInput","label":"NumberInput"},{"type":"doc","id":"reference/web-api/interfaces/OAuthAccessArguments","label":"OAuthAccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/OAuthV2AccessArguments","label":"OAuthV2AccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/OAuthV2ExchangeArguments","label":"OAuthV2ExchangeArguments"},{"type":"doc","id":"reference/web-api/interfaces/OpenIDConnectTokenArguments","label":"OpenIDConnectTokenArguments"},{"type":"doc","id":"reference/web-api/interfaces/OptionField","label":"OptionField"},{"type":"doc","id":"reference/web-api/interfaces/OptionGroup","label":"OptionGroup"},{"type":"doc","id":"reference/web-api/interfaces/Overflow","label":"Overflow"},{"type":"doc","id":"reference/web-api/interfaces/PageReducer","label":"PageReducer"},{"type":"doc","id":"reference/web-api/interfaces/PaginatePredicate","label":"PaginatePredicate"},{"type":"doc","id":"reference/web-api/interfaces/PinsAddArguments","label":"PinsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/PinsListArguments","label":"PinsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/PinsRemoveArguments","label":"PinsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/Placeholdable","label":"Placeholdable"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextElement","label":"PlainTextElement"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextInput","label":"PlainTextInput"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextOption","label":"PlainTextOption"},{"type":"doc","id":"reference/web-api/interfaces/RadioButtons","label":"RadioButtons"},{"type":"doc","id":"reference/web-api/interfaces/ReactionsAddArguments","label":"ReactionsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersAddArguments","label":"RemindersAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersCompleteArguments","label":"RemindersCompleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersDeleteArguments","label":"RemindersDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersInfoArguments","label":"RemindersInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/RetryOptions","label":"RetryOptions"},{"type":"doc","id":"reference/web-api/interfaces/RichTextBlock","label":"RichTextBlock"},{"type":"doc","id":"reference/web-api/interfaces/RichTextBroadcastMention","label":"RichTextBroadcastMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextChannelMention","label":"RichTextChannelMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextColor","label":"RichTextColor"},{"type":"doc","id":"reference/web-api/interfaces/RichTextDate","label":"RichTextDate"},{"type":"doc","id":"reference/web-api/interfaces/RichTextEmoji","label":"RichTextEmoji"},{"type":"doc","id":"reference/web-api/interfaces/RichTextInput","label":"RichTextInput"},{"type":"doc","id":"reference/web-api/interfaces/RichTextLink","label":"RichTextLink"},{"type":"doc","id":"reference/web-api/interfaces/RichTextList","label":"RichTextList"},{"type":"doc","id":"reference/web-api/interfaces/RichTextPreformatted","label":"RichTextPreformatted"},{"type":"doc","id":"reference/web-api/interfaces/RichTextQuote","label":"RichTextQuote"},{"type":"doc","id":"reference/web-api/interfaces/RichTextSection","label":"RichTextSection"},{"type":"doc","id":"reference/web-api/interfaces/RichTextStyleable","label":"RichTextStyleable"},{"type":"doc","id":"reference/web-api/interfaces/RichTextTeamMention","label":"RichTextTeamMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextText","label":"RichTextText"},{"type":"doc","id":"reference/web-api/interfaces/RichTextUserMention","label":"RichTextUserMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextUsergroupMention","label":"RichTextUsergroupMention"},{"type":"doc","id":"reference/web-api/interfaces/SearchAllArguments","label":"SearchAllArguments"},{"type":"doc","id":"reference/web-api/interfaces/SearchFilesArguments","label":"SearchFilesArguments"},{"type":"doc","id":"reference/web-api/interfaces/SearchMessagesArguments","label":"SearchMessagesArguments"},{"type":"doc","id":"reference/web-api/interfaces/SectionBlock","label":"SectionBlock"},{"type":"doc","id":"reference/web-api/interfaces/SelectOption","label":"SelectOption"},{"type":"doc","id":"reference/web-api/interfaces/SlackFileImageObject","label":"SlackFileImageObject"},{"type":"doc","id":"reference/web-api/interfaces/StarsListArguments","label":"StarsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/StaticSelect","label":"StaticSelect"},{"type":"doc","id":"reference/web-api/interfaces/Timepicker","label":"Timepicker"},{"type":"doc","id":"reference/web-api/interfaces/ToolingTokensRotateArguments","label":"ToolingTokensRotateArguments"},{"type":"doc","id":"reference/web-api/interfaces/URLInput","label":"URLInput"},{"type":"doc","id":"reference/web-api/interfaces/UrlImageObject","label":"UrlImageObject"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsCreateArguments","label":"UsergroupsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsDisableArguments","label":"UsergroupsDisableArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsEnableArguments","label":"UsergroupsEnableArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUpdateArguments","label":"UsergroupsUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUsersListArguments","label":"UsergroupsUsersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUsersUpdateArguments","label":"UsergroupsUsersUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersConversationsArguments","label":"UsersConversationsArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersDeletePhotoArguments","label":"UsersDeletePhotoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments","label":"UsersDiscoverableContactsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersGetPresenceArguments","label":"UsersGetPresenceArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersIdentityArguments","label":"UsersIdentityArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersInfoArguments","label":"UsersInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersListArguments","label":"UsersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersLookupByEmailArguments","label":"UsersLookupByEmailArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersProfileGetArguments","label":"UsersProfileGetArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersProfileSetArguments","label":"UsersProfileSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersSelect","label":"UsersSelect"},{"type":"doc","id":"reference/web-api/interfaces/UsersSetPhotoArguments","label":"UsersSetPhotoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersSetPresenceArguments","label":"UsersSetPresenceArguments"},{"type":"doc","id":"reference/web-api/interfaces/VideoBlock","label":"VideoBlock"},{"type":"doc","id":"reference/web-api/interfaces/ViewsPublishArguments","label":"ViewsPublishArguments"},{"type":"doc","id":"reference/web-api/interfaces/WebAPICallResult","label":"WebAPICallResult"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIHTTPError","label":"WebAPIHTTPError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIPlatformError","label":"WebAPIPlatformError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIRateLimitedError","label":"WebAPIRateLimitedError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIRequestError","label":"WebAPIRequestError"},{"type":"doc","id":"reference/web-api/interfaces/WebClientOptions","label":"WebClientOptions"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowButton","label":"WorkflowButton"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowStepView","label":"WorkflowStepView"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsStepCompletedArguments","label":"WorkflowsStepCompletedArguments"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsStepFailedArguments","label":"WorkflowsStepFailedArguments"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsUpdateStepArguments","label":"WorkflowsUpdateStepArguments"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/web-api/type-aliases/APITestArguments","label":"APITestArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAnalyticsGetFileArguments","label":"AdminAnalyticsGetFileArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAnalyticsGetFileResponse","label":"AdminAnalyticsGetFileResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsActivitiesListArguments","label":"AdminAppsActivitiesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsActivitiesListResponse","label":"AdminAppsActivitiesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApproveArguments","label":"AdminAppsApproveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApproveResponse","label":"AdminAppsApproveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApprovedListArguments","label":"AdminAppsApprovedListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApprovedListResponse","label":"AdminAppsApprovedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsClearResolutionArguments","label":"AdminAppsClearResolutionArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsClearResolutionResponse","label":"AdminAppsClearResolutionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsConfigLookupResponse","label":"AdminAppsConfigLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsConfigSetResponse","label":"AdminAppsConfigSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsCancelArguments","label":"AdminAppsRequestsCancelArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsCancelResponse","label":"AdminAppsRequestsCancelResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsListArguments","label":"AdminAppsRequestsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsListResponse","label":"AdminAppsRequestsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictArguments","label":"AdminAppsRestrictArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictResponse","label":"AdminAppsRestrictResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictedListArguments","label":"AdminAppsRestrictedListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictedListResponse","label":"AdminAppsRestrictedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsUninstallArguments","label":"AdminAppsUninstallArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsUninstallResponse","label":"AdminAppsUninstallResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse","label":"AdminAuthPolicyAssignEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse","label":"AdminAuthPolicyGetEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse","label":"AdminAuthPolicyRemoveEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersCreateResponse","label":"AdminBarriersCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersDeleteResponse","label":"AdminBarriersDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersListArguments","label":"AdminBarriersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersListResponse","label":"AdminBarriersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersUpdateResponse","label":"AdminBarriersUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsArchiveResponse","label":"AdminConversationsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse","label":"AdminConversationsBulkArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse","label":"AdminConversationsBulkDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkMoveResponse","label":"AdminConversationsBulkMoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse","label":"AdminConversationsConvertToPrivateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse","label":"AdminConversationsConvertToPublicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsCreateArguments","label":"AdminConversationsCreateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsCreateResponse","label":"AdminConversationsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsDeleteResponse","label":"AdminConversationsDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse","label":"AdminConversationsDisconnectSharedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments","label":"AdminConversationsEKMListOriginalConnectedChannelInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse","label":"AdminConversationsEkmListOriginalConnectedChannelInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse","label":"AdminConversationsGetConversationPrefsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse","label":"AdminConversationsGetCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetTeamsResponse","label":"AdminConversationsGetTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsInviteResponse","label":"AdminConversationsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsLookupResponse","label":"AdminConversationsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse","label":"AdminConversationsRemoveCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRenameResponse","label":"AdminConversationsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse","label":"AdminConversationsRestrictAccessAddGroupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse","label":"AdminConversationsRestrictAccessListGroupsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse","label":"AdminConversationsRestrictAccessRemoveGroupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSearchArguments","label":"AdminConversationsSearchArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSearchResponse","label":"AdminConversationsSearchResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse","label":"AdminConversationsSetConversationPrefsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse","label":"AdminConversationsSetCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetTeamsResponse","label":"AdminConversationsSetTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsUnarchiveResponse","label":"AdminConversationsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse","label":"AdminConversationsWhitelistAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse","label":"AdminConversationsWhitelistListGroupsLinkedToChannelResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse","label":"AdminConversationsWhitelistRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiAddAliasResponse","label":"AdminEmojiAddAliasResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiAddResponse","label":"AdminEmojiAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiListArguments","label":"AdminEmojiListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiListResponse","label":"AdminEmojiListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiRemoveResponse","label":"AdminEmojiRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiRenameResponse","label":"AdminEmojiRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsListResponse","label":"AdminFunctionsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse","label":"AdminFunctionsPermissionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse","label":"AdminFunctionsPermissionsSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsApproveResponse","label":"AdminInviteRequestsApproveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse","label":"AdminInviteRequestsApprovedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse","label":"AdminInviteRequestsDeniedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsDenyResponse","label":"AdminInviteRequestsDenyResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsListResponse","label":"AdminInviteRequestsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse","label":"AdminRolesAddAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesListAssignmentsArguments","label":"AdminRolesListAssignmentsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesListAssignmentsResponse","label":"AdminRolesListAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse","label":"AdminRolesRemoveAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsAdminsListResponse","label":"AdminTeamsAdminsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsCreateResponse","label":"AdminTeamsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsListArguments","label":"AdminTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsListResponse","label":"AdminTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsOwnersListResponse","label":"AdminTeamsOwnersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse","label":"AdminTeamsSettingsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse","label":"AdminTeamsSettingsSetDefaultChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse","label":"AdminTeamsSettingsSetDescriptionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse","label":"AdminTeamsSettingsSetDiscoverabilityResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse","label":"AdminTeamsSettingsSetIconResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse","label":"AdminTeamsSettingsSetNameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse","label":"AdminUsergroupsAddChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse","label":"AdminUsergroupsAddTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse","label":"AdminUsergroupsListChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse","label":"AdminUsergroupsRemoveChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersAssignResponse","label":"AdminUsersAssignResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersInviteResponse","label":"AdminUsersInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersListArguments","label":"AdminUsersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersListResponse","label":"AdminUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersRemoveResponse","label":"AdminUsersRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse","label":"AdminUsersSessionClearSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse","label":"AdminUsersSessionGetSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse","label":"AdminUsersSessionInvalidateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionListArguments","label":"AdminUsersSessionListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionListResponse","label":"AdminUsersSessionListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse","label":"AdminUsersSessionResetBulkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionResetResponse","label":"AdminUsersSessionResetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse","label":"AdminUsersSessionSetSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetAdminResponse","label":"AdminUsersSetAdminResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetExpirationResponse","label":"AdminUsersSetExpirationResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetOwnerResponse","label":"AdminUsersSetOwnerResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetRegularResponse","label":"AdminUsersSetRegularResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse","label":"AdminUsersUnsupportedVersionsExportResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse","label":"AdminWorkflowsCollaboratorsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse","label":"AdminWorkflowsCollaboratorsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse","label":"AdminWorkflowsPermissionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsSearchArguments","label":"AdminWorkflowsSearchArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsSearchResponse","label":"AdminWorkflowsSearchResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse","label":"AdminWorkflowsUnpublishResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ApiTestResponse","label":"ApiTestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsConnectionsOpenArguments","label":"AppsConnectionsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AppsConnectionsOpenResponse","label":"AppsConnectionsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsEventAuthorizationsListResponse","label":"AppsEventAuthorizationsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestCreateResponse","label":"AppsManifestCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestDeleteResponse","label":"AppsManifestDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestExportResponse","label":"AppsManifestExportResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestUpdateResponse","label":"AppsManifestUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestValidateResponse","label":"AppsManifestValidateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsInfoResponse","label":"AppsPermissionsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsRequestResponse","label":"AppsPermissionsRequestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsResourcesListResponse","label":"AppsPermissionsResourcesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsScopesListResponse","label":"AppsPermissionsScopesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsUsersListResponse","label":"AppsPermissionsUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse","label":"AppsPermissionsUsersRequestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsUninstallResponse","label":"AppsUninstallResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthRevokeArguments","label":"AuthRevokeArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthRevokeResponse","label":"AuthRevokeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTeamsListArguments","label":"AuthTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTeamsListResponse","label":"AuthTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTestArguments","label":"AuthTestArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTestResponse","label":"AuthTestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksAddResponse","label":"BookmarksAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksEditResponse","label":"BookmarksEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksListResponse","label":"BookmarksListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksRemoveResponse","label":"BookmarksRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BotsInfoArguments","label":"BotsInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/BotsInfoResponse","label":"BotsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallUser","label":"CallUser"},{"type":"doc","id":"reference/web-api/type-aliases/CallsAddResponse","label":"CallsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsEndResponse","label":"CallsEndResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsInfoResponse","label":"CallsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsParticipantsAddResponse","label":"CallsParticipantsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsParticipantsRemoveResponse","label":"CallsParticipantsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsUpdateResponse","label":"CallsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesAccessDeleteResponse","label":"CanvasesAccessDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesAccessSetResponse","label":"CanvasesAccessSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesCreateArguments","label":"CanvasesCreateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesCreateResponse","label":"CanvasesCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesDeleteResponse","label":"CanvasesDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesEditResponse","label":"CanvasesEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesSectionsLookupResponse","label":"CanvasesSectionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsArchiveResponse","label":"ChannelsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsCreateResponse","label":"ChannelsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsHistoryResponse","label":"ChannelsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsInfoResponse","label":"ChannelsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsInviteResponse","label":"ChannelsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsJoinResponse","label":"ChannelsJoinResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsKickResponse","label":"ChannelsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsLeaveResponse","label":"ChannelsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsListResponse","label":"ChannelsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsMarkResponse","label":"ChannelsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsRenameResponse","label":"ChannelsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsRepliesResponse","label":"ChannelsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsSetPurposeResponse","label":"ChannelsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsSetTopicResponse","label":"ChannelsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsUnarchiveResponse","label":"ChannelsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatDeleteResponse","label":"ChatDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse","label":"ChatDeleteScheduledMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatGetPermalinkResponse","label":"ChatGetPermalinkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatMeMessageResponse","label":"ChatMeMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostEphemeralArguments","label":"ChatPostEphemeralArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostEphemeralResponse","label":"ChatPostEphemeralResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostMessageArguments","label":"ChatPostMessageArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostMessageResponse","label":"ChatPostMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduleMessageArguments","label":"ChatScheduleMessageArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduleMessageResponse","label":"ChatScheduleMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduledMessagesListArguments","label":"ChatScheduledMessagesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduledMessagesListResponse","label":"ChatScheduledMessagesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUnfurlArguments","label":"ChatUnfurlArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUnfurlResponse","label":"ChatUnfurlResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUpdateArguments","label":"ChatUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUpdateResponse","label":"ChatUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationFilter","label":"ConversationFilter"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments","label":"ConversationsAcceptSharedInviteArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse","label":"ConversationsAcceptSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse","label":"ConversationsApproveSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsArchiveResponse","label":"ConversationsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCanvasesCreateResponse","label":"ConversationsCanvasesCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCloseResponse","label":"ConversationsCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCreateResponse","label":"ConversationsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse","label":"ConversationsDeclineSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse","label":"ConversationsExternalInvitePermissionsSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsHistoryResponse","label":"ConversationsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInfoResponse","label":"ConversationsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteResponse","label":"ConversationsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteSharedArguments","label":"ConversationsInviteSharedArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteSharedResponse","label":"ConversationsInviteSharedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsJoinResponse","label":"ConversationsJoinResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsKickResponse","label":"ConversationsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsLeaveResponse","label":"ConversationsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListArguments","label":"ConversationsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListConnectInvitesArguments","label":"ConversationsListConnectInvitesArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListConnectInvitesResponse","label":"ConversationsListConnectInvitesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListResponse","label":"ConversationsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsMarkResponse","label":"ConversationsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsMembersResponse","label":"ConversationsMembersResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsOpenArguments","label":"ConversationsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsOpenResponse","label":"ConversationsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsRenameResponse","label":"ConversationsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsRepliesResponse","label":"ConversationsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsSetPurposeResponse","label":"ConversationsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsSetTopicResponse","label":"ConversationsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsUnarchiveResponse","label":"ConversationsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DialogOpenResponse","label":"DialogOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndDndArguments","label":"DndEndDndArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndDndResponse","label":"DndEndDndResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndSnoozeArguments","label":"DndEndSnoozeArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndSnoozeResponse","label":"DndEndSnoozeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndInfoArguments","label":"DndInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndInfoResponse","label":"DndInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndSetSnoozeResponse","label":"DndSetSnoozeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndTeamInfoResponse","label":"DndTeamInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/EmojiListArguments","label":"EmojiListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/EmojiListResponse","label":"EmojiListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsAddResponse","label":"FilesCommentsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsDeleteResponse","label":"FilesCommentsDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsEditResponse","label":"FilesCommentsEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCompleteUploadExternalArguments","label":"FilesCompleteUploadExternalArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCompleteUploadExternalResponse","label":"FilesCompleteUploadExternalResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesDeleteResponse","label":"FilesDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesGetUploadURLExternalResponse","label":"FilesGetUploadURLExternalResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesInfoResponse","label":"FilesInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesListResponse","label":"FilesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteAddResponse","label":"FilesRemoteAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteInfoArguments","label":"FilesRemoteInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteInfoResponse","label":"FilesRemoteInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteListResponse","label":"FilesRemoteListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteRemoveArguments","label":"FilesRemoteRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteRemoveResponse","label":"FilesRemoteRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteShareArguments","label":"FilesRemoteShareArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteShareResponse","label":"FilesRemoteShareResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteUpdateArguments","label":"FilesRemoteUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteUpdateResponse","label":"FilesRemoteUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRevokePublicURLResponse","label":"FilesRevokePublicURLResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesSharedPublicURLResponse","label":"FilesSharedPublicURLResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadArguments","label":"FilesUploadArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadResponse","label":"FilesUploadResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadV2Arguments","label":"FilesUploadV2Arguments"},{"type":"doc","id":"reference/web-api/type-aliases/FunctionsCompleteErrorResponse","label":"FunctionsCompleteErrorResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FunctionsCompleteSuccessResponse","label":"FunctionsCompleteSuccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsArchiveResponse","label":"GroupsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCloseResponse","label":"GroupsCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCreateChildResponse","label":"GroupsCreateChildResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCreateResponse","label":"GroupsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsHistoryResponse","label":"GroupsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsInfoResponse","label":"GroupsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsInviteResponse","label":"GroupsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsKickResponse","label":"GroupsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsLeaveResponse","label":"GroupsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsListResponse","label":"GroupsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsMarkResponse","label":"GroupsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsOpenResponse","label":"GroupsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsRenameResponse","label":"GroupsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsRepliesResponse","label":"GroupsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsSetPurposeResponse","label":"GroupsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsSetTopicResponse","label":"GroupsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsUnarchiveResponse","label":"GroupsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImCloseResponse","label":"ImCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImHistoryResponse","label":"ImHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImListResponse","label":"ImListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImMarkResponse","label":"ImMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImOpenResponse","label":"ImOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImRepliesResponse","label":"ImRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImageBlock","label":"ImageBlock"},{"type":"doc","id":"reference/web-api/type-aliases/ImageElement","label":"ImageElement"},{"type":"doc","id":"reference/web-api/type-aliases/KnownBlock","label":"KnownBlock"},{"type":"doc","id":"reference/web-api/type-aliases/MigrationExchangeResponse","label":"MigrationExchangeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimCloseResponse","label":"MpimCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimHistoryResponse","label":"MpimHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimListResponse","label":"MpimListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimMarkResponse","label":"MpimMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimOpenResponse","label":"MpimOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimRepliesResponse","label":"MpimRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MultiSelect","label":"MultiSelect"},{"type":"doc","id":"reference/web-api/type-aliases/OauthAccessResponse","label":"OauthAccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthTokenResponse","label":"OauthTokenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthV2AccessResponse","label":"OauthV2AccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthV2ExchangeResponse","label":"OauthV2ExchangeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectTokenResponse","label":"OpenIDConnectTokenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectUserInfoArguments","label":"OpenIDConnectUserInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectUserInfoResponse","label":"OpenIDConnectUserInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/Option","label":"Option"},{"type":"doc","id":"reference/web-api/type-aliases/PageAccumulator","label":"PageAccumulator"},{"type":"doc","id":"reference/web-api/type-aliases/PinsAddResponse","label":"PinsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/PinsListResponse","label":"PinsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/PinsRemoveResponse","label":"PinsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RTMConnectArguments","label":"RTMConnectArguments"},{"type":"doc","id":"reference/web-api/type-aliases/RTMStartArguments","label":"RTMStartArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsAddResponse","label":"ReactionsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsGetArguments","label":"ReactionsGetArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsGetResponse","label":"ReactionsGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsListArguments","label":"ReactionsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsListResponse","label":"ReactionsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsRemoveArguments","label":"ReactionsRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsRemoveResponse","label":"ReactionsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersAddResponse","label":"RemindersAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersCompleteResponse","label":"RemindersCompleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersDeleteResponse","label":"RemindersDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersInfoResponse","label":"RemindersInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersListArguments","label":"RemindersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersListResponse","label":"RemindersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RichTextElement","label":"RichTextElement"},{"type":"doc","id":"reference/web-api/type-aliases/RtmConnectResponse","label":"RtmConnectResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RtmStartResponse","label":"RtmStartResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchAllResponse","label":"SearchAllResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchFilesResponse","label":"SearchFilesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchMessagesResponse","label":"SearchMessagesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/Select","label":"Select"},{"type":"doc","id":"reference/web-api/type-aliases/SlackFile","label":"SlackFile"},{"type":"doc","id":"reference/web-api/type-aliases/StarsAddRemoveArguments","label":"StarsAddRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/StarsAddResponse","label":"StarsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/StarsListResponse","label":"StarsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/StarsRemoveResponse","label":"StarsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TLSOptions","label":"TLSOptions"},{"type":"doc","id":"reference/web-api/type-aliases/TeamAccessLogsArguments","label":"TeamAccessLogsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamAccessLogsResponse","label":"TeamAccessLogsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillableInfoArguments","label":"TeamBillableInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillableInfoResponse","label":"TeamBillableInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillingInfoArguments","label":"TeamBillingInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillingInfoResponse","label":"TeamBillingInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments","label":"TeamExternalTeamsDisconnectArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse","label":"TeamExternalTeamsDisconnectResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsListArguments","label":"TeamExternalTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsListResponse","label":"TeamExternalTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamInfoArguments","label":"TeamInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamInfoResponse","label":"TeamInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamIntegrationLogsArguments","label":"TeamIntegrationLogsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamIntegrationLogsResponse","label":"TeamIntegrationLogsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamPreferencesListArguments","label":"TeamPreferencesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamPreferencesListResponse","label":"TeamPreferencesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamProfileGetArguments","label":"TeamProfileGetArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamProfileGetResponse","label":"TeamProfileGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ToolingTokensRotateResponse","label":"ToolingTokensRotateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsCreateResponse","label":"UsergroupsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsDisableResponse","label":"UsergroupsDisableResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsEnableResponse","label":"UsergroupsEnableResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsListArguments","label":"UsergroupsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsListResponse","label":"UsergroupsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUpdateResponse","label":"UsergroupsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUsersListResponse","label":"UsergroupsUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUsersUpdateResponse","label":"UsergroupsUsersUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersConversationsResponse","label":"UsersConversationsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersDeletePhotoResponse","label":"UsersDeletePhotoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse","label":"UsersDiscoverableContactsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersGetPresenceResponse","label":"UsersGetPresenceResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersIdentityResponse","label":"UsersIdentityResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersInfoResponse","label":"UsersInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersListResponse","label":"UsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersLookupByEmailResponse","label":"UsersLookupByEmailResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersProfileGetResponse","label":"UsersProfileGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersProfileSetResponse","label":"UsersProfileSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetActiveResponse","label":"UsersSetActiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetPhotoResponse","label":"UsersSetPhotoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetPresenceResponse","label":"UsersSetPresenceResponse"},{"type":"doc","id":"reference/web-api/type-aliases/View","label":"View"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsOpenArguments","label":"ViewsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsOpenResponse","label":"ViewsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPublishResponse","label":"ViewsPublishResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPushArguments","label":"ViewsPushArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPushResponse","label":"ViewsPushResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsUpdateArguments","label":"ViewsUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsUpdateResponse","label":"ViewsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WebAPICallError","label":"WebAPICallError"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsStepCompletedResponse","label":"WorkflowsStepCompletedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsStepFailedResponse","label":"WorkflowsStepFailedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsUpdateStepResponse","label":"WorkflowsUpdateStepResponse"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/web-api/variables/retryPolicies","label":"retryPolicies"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/web-api/functions/addAppMetadata","label":"addAppMetadata"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/web-api/variables/retryPolicies.md b/docs/content/reference/web-api/variables/retryPolicies.md new file mode 100644 index 000000000..f46e8dd23 --- /dev/null +++ b/docs/content/reference/web-api/variables/retryPolicies.md @@ -0,0 +1,29 @@ +# Variable: retryPolicies + +```ts +const retryPolicies: object; +``` + +## Type declaration + +### fiveRetriesInFiveMinutes + +```ts +fiveRetriesInFiveMinutes: RetryOptions; +``` + +### rapidRetryPolicy + +```ts +rapidRetryPolicy: RetryOptions; +``` + +### tenRetriesInAboutThirtyMinutes + +```ts +tenRetriesInAboutThirtyMinutes: RetryOptions; +``` + +## Defined in + +[packages/web-api/src/retry-policies.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/retry-policies.ts#L37) diff --git a/docs/content/reference/webhook/classes/IncomingWebhook.md b/docs/content/reference/webhook/classes/IncomingWebhook.md new file mode 100644 index 000000000..5a998380d --- /dev/null +++ b/docs/content/reference/webhook/classes/IncomingWebhook.md @@ -0,0 +1,49 @@ +# Class: IncomingWebhook + +A client for Slack's Incoming Webhooks + +## Constructors + +### new IncomingWebhook() + +```ts +new IncomingWebhook(url, defaults): IncomingWebhook +``` + +#### Parameters + +• **url**: `string` + +• **defaults**: [`IncomingWebhookDefaultArguments`](../interfaces/IncomingWebhookDefaultArguments.md) = `...` + +#### Returns + +[`IncomingWebhook`](IncomingWebhook.md) + +#### Defined in + +[IncomingWebhook.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L28) + +## Methods + +### send() + +```ts +send(message): Promise +``` + +Send a notification to a conversation + +#### Parameters + +• **message**: `string` \| [`IncomingWebhookSendArguments`](../interfaces/IncomingWebhookSendArguments.md) + +the message (a simple string, or an object describing the message) + +#### Returns + +`Promise`\<[`IncomingWebhookResult`](../interfaces/IncomingWebhookResult.md)\> + +#### Defined in + +[IncomingWebhook.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L61) diff --git a/docs/content/reference/webhook/enumerations/ErrorCode.md b/docs/content/reference/webhook/enumerations/ErrorCode.md new file mode 100644 index 000000000..e359c655f --- /dev/null +++ b/docs/content/reference/webhook/enumerations/ErrorCode.md @@ -0,0 +1,27 @@ +# Enumeration: ErrorCode + +A dictionary of codes for errors produced by this package + +## Enumeration Members + +### HTTPError + +```ts +HTTPError: "slack_webhook_http_error"; +``` + +#### Defined in + +[errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L15) + +*** + +### RequestError + +```ts +RequestError: "slack_webhook_request_error"; +``` + +#### Defined in + +[errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L14) diff --git a/docs/content/reference/webhook/index.md b/docs/content/reference/webhook/index.md new file mode 100644 index 000000000..6b1dc3b68 --- /dev/null +++ b/docs/content/reference/webhook/index.md @@ -0,0 +1,22 @@ +# @slack/webhook + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) + +## Classes + +- [IncomingWebhook](classes/IncomingWebhook.md) + +## Interfaces + +- [CodedError](interfaces/CodedError.md) +- [IncomingWebhookDefaultArguments](interfaces/IncomingWebhookDefaultArguments.md) +- [IncomingWebhookHTTPError](interfaces/IncomingWebhookHTTPError.md) +- [IncomingWebhookRequestError](interfaces/IncomingWebhookRequestError.md) +- [IncomingWebhookResult](interfaces/IncomingWebhookResult.md) +- [IncomingWebhookSendArguments](interfaces/IncomingWebhookSendArguments.md) + +## Type Aliases + +- [IncomingWebhookSendError](type-aliases/IncomingWebhookSendError.md) diff --git a/docs/content/reference/webhook/interfaces/CodedError.md b/docs/content/reference/webhook/interfaces/CodedError.md new file mode 100644 index 000000000..ae9917051 --- /dev/null +++ b/docs/content/reference/webhook/interfaces/CodedError.md @@ -0,0 +1,24 @@ +# Interface: CodedError + +All errors produced by this package adhere to this interface + +## Extends + +- `ErrnoException` + +## Extended by + +- [`IncomingWebhookRequestError`](IncomingWebhookRequestError.md) +- [`IncomingWebhookHTTPError`](IncomingWebhookHTTPError.md) + +## Properties + +### code + +```ts +code: ErrorCode; +``` + +#### Defined in + +[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L7) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md b/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md new file mode 100644 index 000000000..687cd79c7 --- /dev/null +++ b/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md @@ -0,0 +1,101 @@ +# Interface: IncomingWebhookDefaultArguments + +## Extended by + +- [`IncomingWebhookSendArguments`](IncomingWebhookSendArguments.md) + +## Properties + +### agent? + +```ts +optional agent: any; +``` + +#### Defined in + +[IncomingWebhook.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L109) + +*** + +### channel? + +```ts +optional channel: string; +``` + +#### Defined in + +[IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) + +*** + +### icon\_emoji? + +```ts +optional icon_emoji: string; +``` + +#### Defined in + +[IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) + +*** + +### icon\_url? + +```ts +optional icon_url: string; +``` + +#### Defined in + +[IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) + +*** + +### link\_names? + +```ts +optional link_names: boolean; +``` + +#### Defined in + +[IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) + +*** + +### text? + +```ts +optional text: string; +``` + +#### Defined in + +[IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) + +*** + +### timeout? + +```ts +optional timeout: number; +``` + +#### Defined in + +[IncomingWebhook.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L110) + +*** + +### username? + +```ts +optional username: string; +``` + +#### Defined in + +[IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md b/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md new file mode 100644 index 000000000..e90145106 --- /dev/null +++ b/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md @@ -0,0 +1,35 @@ +# Interface: IncomingWebhookHTTPError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: HTTPError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L26) + +*** + +### original + +```ts +original: Error; +``` + +#### Defined in + +[errors.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L27) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md b/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md new file mode 100644 index 000000000..781efb2f0 --- /dev/null +++ b/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md @@ -0,0 +1,35 @@ +# Interface: IncomingWebhookRequestError + +All errors produced by this package adhere to this interface + +## Extends + +- [`CodedError`](CodedError.md) + +## Properties + +### code + +```ts +code: RequestError; +``` + +#### Overrides + +[`CodedError`](CodedError.md).[`code`](CodedError.md#code) + +#### Defined in + +[errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L21) + +*** + +### original + +```ts +original: Error; +``` + +#### Defined in + +[errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L22) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md b/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md new file mode 100644 index 000000000..e1ef9cf0e --- /dev/null +++ b/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md @@ -0,0 +1,13 @@ +# Interface: IncomingWebhookResult + +## Properties + +### text + +```ts +text: string; +``` + +#### Defined in + +[IncomingWebhook.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L126) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md b/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md new file mode 100644 index 000000000..2f247bc3c --- /dev/null +++ b/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md @@ -0,0 +1,205 @@ +# Interface: IncomingWebhookSendArguments + +## Extends + +- [`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md) + +## Properties + +### agent? + +```ts +optional agent: any; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`agent`](IncomingWebhookDefaultArguments.md#agent) + +#### Defined in + +[IncomingWebhook.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L109) + +*** + +### attachments? + +```ts +optional attachments: MessageAttachment[]; +``` + +#### Defined in + +[IncomingWebhook.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L114) + +*** + +### blocks? + +```ts +optional blocks: any[]; +``` + +#### Defined in + +[IncomingWebhook.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L115) + +*** + +### channel? + +```ts +optional channel: string; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`channel`](IncomingWebhookDefaultArguments.md#channel) + +#### Defined in + +[IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) + +*** + +### icon\_emoji? + +```ts +optional icon_emoji: string; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`icon_emoji`](IncomingWebhookDefaultArguments.md#icon_emoji) + +#### Defined in + +[IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) + +*** + +### icon\_url? + +```ts +optional icon_url: string; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`icon_url`](IncomingWebhookDefaultArguments.md#icon_url) + +#### Defined in + +[IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) + +*** + +### link\_names? + +```ts +optional link_names: boolean; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`link_names`](IncomingWebhookDefaultArguments.md#link_names) + +#### Defined in + +[IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) + +*** + +### metadata? + +```ts +optional metadata: object; +``` + +#### event\_payload + +```ts +event_payload: Record; +``` + +#### event\_type + +```ts +event_type: string; +``` + +#### Defined in + +[IncomingWebhook.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L118) + +*** + +### text? + +```ts +optional text: string; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`text`](IncomingWebhookDefaultArguments.md#text) + +#### Defined in + +[IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) + +*** + +### timeout? + +```ts +optional timeout: number; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`timeout`](IncomingWebhookDefaultArguments.md#timeout) + +#### Defined in + +[IncomingWebhook.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L110) + +*** + +### unfurl\_links? + +```ts +optional unfurl_links: boolean; +``` + +#### Defined in + +[IncomingWebhook.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L116) + +*** + +### unfurl\_media? + +```ts +optional unfurl_media: boolean; +``` + +#### Defined in + +[IncomingWebhook.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L117) + +*** + +### username? + +```ts +optional username: string; +``` + +#### Inherited from + +[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`username`](IncomingWebhookDefaultArguments.md#username) + +#### Defined in + +[IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) diff --git a/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md b/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md new file mode 100644 index 000000000..54ef5daf5 --- /dev/null +++ b/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md @@ -0,0 +1,9 @@ +# Type Alias: IncomingWebhookSendError + +```ts +type IncomingWebhookSendError: IncomingWebhookRequestError | IncomingWebhookHTTPError; +``` + +## Defined in + +[errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L18) diff --git a/docs/content/reference/webhook/typedoc-sidebar.cjs b/docs/content/reference/webhook/typedoc-sidebar.cjs new file mode 100644 index 000000000..67b03d1b3 --- /dev/null +++ b/docs/content/reference/webhook/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/webhook/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/webhook/classes/IncomingWebhook","label":"IncomingWebhook"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/webhook/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookDefaultArguments","label":"IncomingWebhookDefaultArguments"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookHTTPError","label":"IncomingWebhookHTTPError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookRequestError","label":"IncomingWebhookRequestError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookResult","label":"IncomingWebhookResult"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookSendArguments","label":"IncomingWebhookSendArguments"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/webhook/type-aliases/IncomingWebhookSendError","label":"IncomingWebhookSendError"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/_tutorials/basic-information-page.png b/docs/content/tutorials/basic-information-page.png similarity index 100% rename from docs/_tutorials/basic-information-page.png rename to docs/content/tutorials/basic-information-page.png diff --git a/docs/_tutorials/bot-token.png b/docs/content/tutorials/bot-token.png similarity index 100% rename from docs/_tutorials/bot-token.png rename to docs/content/tutorials/bot-token.png diff --git a/docs/_tutorials/local_development.md b/docs/content/tutorials/local-development.md similarity index 79% rename from docs/_tutorials/local_development.md rename to docs/content/tutorials/local-development.md index 88a18c08b..a40e14852 100644 --- a/docs/_tutorials/local_development.md +++ b/docs/content/tutorials/local-development.md @@ -1,7 +1,5 @@ --- title: Developing Slack apps locally -order: 1 -slug: local_development --- # Developing Slack apps locally @@ -10,24 +8,11 @@ This tutorial is meant to guide developers through setting up and configuring a Feel free to skip around to the specific sections relevant to you — we won't mind 🙂 -- [Create an app](#create-an-app) -- [Tokens and installing apps](#tokens-and-installing-apps) -- [Socket Mode vs. HTTP](#socket-mode-vs-http) - - [Socket Mode](#socket-mode) - - [HTTP](#http) - - [What is a Request URL?](#what-is-a-request-url) - - [Using a local Request URL for development](#using-a-local-request-url-for-development) - - [Add Request URL to your app configuration](#add-the-url-to-your-app-configuration) -- [Subscribing to workspace events](#subscribing-to-workspace-events) -- [Adding event subscriptions](#adding-event-subscriptions) -- [Next steps](#next-steps) - - ## Create an app -Head over to our [Bolt JS Getting Started Guide's section "Create an App"](https://slack.dev/bolt-js/tutorial/getting-started#create-an-app) for the latest up-to-date instructions on how to create a new app on [api.slack.com/apps](https://api.slack.com/apps). +Head over to [Create an app](https://slack.dev/bolt-js/getting-started#create-an-app) within our Getting started with JavaScript for Bolt page for instructions on how to create a Slack app on [api.slack.com/apps](https://api.slack.com/apps). ## Tokens and installing apps -Head over to our [Bolt JS Getting Started Guide's section "Tokens and installing apps"](https://slack.dev/bolt-js/tutorial/getting-started#tokens-and-installing-apps) for the latest up-to-date information on what tokens are, the [different kinds of tokens available](https://api.slack.com/docs/token-types), how to create them on [api.slack.com/apps](https://api.slack.com/apps), how to install your app to a live Slack workspace and finally how to retrieve your access token. +Head over to [Tokens and installing apps](https://slack.dev/bolt-js/getting-started#tokens-and-installing-apps) within our Getting started with JavaScript for Bolt page for information on what tokens are, the [different kinds of tokens available](https://api.slack.com/docs/token-types), how to create them on [api.slack.com/apps](https://api.slack.com/apps), how to install your app to a live Slack workspace and finally how to retrieve your access token. ## Socket Mode vs. HTTP Your app can [communicate with Slack using one of two methods](https://api.slack.com/apis/connections): @@ -39,7 +24,7 @@ This tutorial will cover how to set up your app using either approach. ### Socket Mode -Setting up your Node.js application for Socket Mode development is fast and easy with the [`@slack/socket-mode`](https://slack.dev/node-slack-sdk/socket-mode) package. +Setting up your Node.js application for Socket Mode development is fast and easy with the [`@slack/socket-mode`](/socket-mode) package. Once you've [created an app](#create-an-app), you will need to generate an **App Token**. On your app's page on [api.slack.com/apps](https://api.slack.com/apps), under the main **Basic Information** page, scroll down to **App-Level Tokens**. Click **Generate Token and Scopes**, add a name for your app token, and click **Add Scope**. Choose `connections:write` and then click **Generate**. Copy and safely store the generated token - you'll need that when following the [Socket Mode package setup instructions](../socket-mode). diff --git a/docs/_tutorials/migrating_to_v5.md b/docs/content/tutorials/migrating-to-v5.md similarity index 95% rename from docs/_tutorials/migrating_to_v5.md rename to docs/content/tutorials/migrating-to-v5.md index 5939f194c..c50ba419c 100644 --- a/docs/_tutorials/migrating_to_v5.md +++ b/docs/content/tutorials/migrating-to-v5.md @@ -1,7 +1,5 @@ --- title: Migrating to v5.x -order: 1 -slug: migrating_to_v5 --- # Migration Guide (v4 to v5) @@ -11,18 +9,26 @@ 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. -**Note**: If you were using the `@slack/events-api` or `@slack/interactive-messages` packages, this migration doesn't +:::info + +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! +::: + ## 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. -**Note**: Learn more about our [support schedule](https://github.com/slackapi/node-slack-sdk/wiki/Support-Schedule) so +:::info + +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. +::: + ## Choose the right packages In `v4.x` versions, the package came with a few classes. If your app only needed one or two of these classes, then @@ -232,7 +238,7 @@ comparison. The `WebAPICallReadError` was never used by the `WebClient`. ### Logger objects If your app set the `logger` option to a function, you need to update the code to instead use an object with methods -for each log level. See details in [the logging documentation](https://slack.dev/node-slack-sdk/web-api#logging). +for each log level. See details in [the logging documentation](/web-api#logging). ### New retry policies @@ -325,7 +331,7 @@ literal, you need to update that code. Instead, compare with a property of the e ### Logger objects If your app set the `logger` option to a function, you need to update the code to instead use an object with methods -for each log level. See details in [the logging documentation](https://slack.dev/node-slack-sdk/rtm-api#logging). +for each log level. See details in [the logging documentation](/rtm-api#logging). ## IncomingWebhook @@ -402,4 +408,4 @@ The `IncomingWebhook` prefix from the property names of `ErrorCode` have been re `ErrorCode.IncomingWebhookRequestError` is now `ErrorCode.RequestError`. The string values of error codes in `ErrorCode` export have changed. If your app compares the `error.code` with a string -literal, you need to update that code. Instead, compare with a property of the export such as `ErrorCode.RequestError`. +literal, you need to update that code. Instead, compare with a property of the export such as `ErrorCode.RequestError`. \ No newline at end of file diff --git a/docs/_tutorials/migrating_to_v6.md b/docs/content/tutorials/migrating-to-v6.md similarity index 95% rename from docs/_tutorials/migrating_to_v6.md rename to docs/content/tutorials/migrating-to-v6.md index 3de37d26c..c26cdd3a8 100644 --- a/docs/_tutorials/migrating_to_v6.md +++ b/docs/content/tutorials/migrating-to-v6.md @@ -1,7 +1,5 @@ --- title: Migrating to v6.x -order: 1 -slug: migrating_to_v6 --- # Migration Guide (v5 to v6) @@ -23,7 +21,11 @@ To migrate to the latest packages, updating your minimum Node.js to `12.13.0` is Our newly released major versions all require a minimum Node version of `12.13.0` and minimum npm version of `6.12.0` . -**Note**: 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](https://github.com/slackapi/node-slack-sdk/wiki/Support-Schedule) so that you can prepare and plan for future updates. + +::: ### Minimum TypeScript Version @@ -122,6 +124,4 @@ app.action('buttonActionId', async ({ action, ack }) => { await ack(); }); // @slack/bolt also has listeners for options, view, slash commands and shortcuts -``` - - +``` \ No newline at end of file diff --git a/docs/_tutorials/ngrok.gif b/docs/content/tutorials/ngrok.gif similarity index 100% rename from docs/_tutorials/ngrok.gif rename to docs/content/tutorials/ngrok.gif diff --git a/docs/_tutorials/request-url-config.png b/docs/content/tutorials/request-url-config.png similarity index 100% rename from docs/_tutorials/request-url-config.png rename to docs/content/tutorials/request-url-config.png diff --git a/docs/_tutorials/signing-secret.png b/docs/content/tutorials/signing-secret.png similarity index 100% rename from docs/_tutorials/signing-secret.png rename to docs/content/tutorials/signing-secret.png diff --git a/docs/_main/typescript.md b/docs/content/typescript.md similarity index 94% rename from docs/_main/typescript.md rename to docs/content/typescript.md index 36cb13075..f3e801cba 100644 --- a/docs/_main/typescript.md +++ b/docs/content/typescript.md @@ -1,7 +1,5 @@ --- title: Using TypeScript -permalink: /typescript -order: 5 --- This project is mostly written and built using [TypeScript](https://www.typescriptlang.org/), which means many of the APIs have type information metadata 🎉. If you're using a code editor like VSCode, Atom, or many others that know how to read that metadata, or if you're using TypeScript in your own project, you'll benefit from improved documentation as your write code, early detection of errors, easier refactoring, and more. @@ -14,7 +12,7 @@ This page helps describe how to use this package from a project that also uses T Latest major versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript version 5.3.x. You can try to use a greater minor version of Typescript like 5.4 or above, but beware that [API Breaking Changes](https://github.com/microsoft/TypeScript/wiki/API-Breaking-Changes) can be introduced in minor Typescript versions that break compatibility. -The v6 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against the minimum TypeScript version v4.1.0. See also [v5 to v6 migration guide](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for more details. +The v6 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against the minimum TypeScript version v4.1.0. See also [v5 to v6 migration guide](/tutorials/migrating-to-v6) for more details. 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. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js new file mode 100644 index 000000000..83ecdc331 --- /dev/null +++ b/docs/docusaurus.config.js @@ -0,0 +1,272 @@ +// @ts-check +// `@type` JSDoc annotations allow editor autocompletion and type checking +// (when paired with `@ts-check`). +// There are various equivalent ways to declare your Docusaurus config. +// See: https://docusaurus.io/docs/api/docusaurus-config + +import {themes as prismThemes} from 'prism-react-renderer'; + +/** @type {import('@docusaurus/types').Config} */ +const config = { + title: 'Node Slack SDK', + tagline: 'Official frameworks, libraries, and SDKs for Slack developers', + favicon: 'img/favicon.ico', + + url: 'https://slack.dev', + baseUrl: '/node-slack-sdk/', + organizationName: 'slackapi', + projectName: 'node-slack-sdk', + + onBrokenLinks: 'warn', + onBrokenAnchors: 'warn', + onBrokenMarkdownLinks: 'warn', + + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + path: 'content', + breadcrumbs: false, + routeBasePath: '/', // Serve the docs at the site's root + sidebarPath: './sidebars.js', + editUrl: 'https://github.com/slackapi/node-slack-sdk/tree/main/docs', + }, + blog: false, + theme: { + customCss: './src/css/custom.css', + }, + }), + ], + ], + + plugins: + ['docusaurus-theme-github-codeblock', + + ['@docusaurus/plugin-client-redirects', + { + redirects: [ + { + to: '/getting-started#getting-a-token-to-use-the-web-api', + from: ['/auth'], + }, + { + to: '/reference/logger', + from: ['/reference'], + }, + { + to: 'https://github.com/SlackAPI/node-slack-sdk/releases', + from: ['/changelog'], + }, + ], + }, + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'events-api', + entryPoints: ['../packages/events-api/src/index.ts'], + tsconfig: '../packages/events-api/tsconfig.json', + out: "./content/reference/events-api", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'interactive-messages', + entryPoints: ['../packages/interactive-messages/src/index.ts'], + tsconfig: '../packages/interactive-messages/tsconfig.json', + out: "./content/reference/interactive-messages", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'logger', + entryPoints: ['../packages/logger/src/index.ts'], + tsconfig: '../packages/logger/tsconfig.json', + out: "./content/reference/logger", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'oauth', + entryPoints: ['../packages/oauth/src/index.ts'], + tsconfig: '../packages/oauth/tsconfig.json', + out: "./content/reference/oauth", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'rtm-api', + entryPoints: ['../packages/rtm-api/src/index.ts'], + tsconfig: '../packages/rtm-api/tsconfig.json', + out: "./content/reference/rtm-api", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'socket-mode', + entryPoints: ['../packages/socket-mode/src/index.ts'], + tsconfig: '../packages/socket-mode/tsconfig.json', + out: "./content/reference/socket-mode", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'types', + entryPoints: ['../packages/types/src/index.ts'], + tsconfig: '../packages/types/tsconfig.json', + out: "./content/reference/types", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'web', + entryPoints: ['../packages/web-api/src/index.ts'], + tsconfig: '../packages/web-api/tsconfig.json', + out: "./content/reference/web-api", + } + ], + [ + 'docusaurus-plugin-typedoc', + { + id: 'webhook', + entryPoints: ['../packages/webhook/src/index.ts'], + tsconfig: '../packages/webhook/tsconfig.json', + out: "./content/reference/webhook", + } + ] + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + ({ + colorMode: { + respectPrefersColorScheme: true, + }, + docs: { + sidebar: { + autoCollapseCategories: true, + }, + }, + navbar: { + title: "Slack Developer Tools", + logo: { + alt: 'Slack logo', + src: 'img/slack-logo.svg', + href: 'https://slack.dev', + target : '_self' + }, + items: [ + { + type: 'dropdown', + label: 'Bolt', + position: 'left', + items: [ + { + label: 'Java', + to: 'https://slack.dev/java-slack-sdk/guides/bolt-basics', + target: '_self', + }, + { + label: 'JavaScript', + to: 'https://slack.dev/node-slack-sdk', + target: '_self', + }, + { + label: 'Python', + to: 'https://slack.dev/bolt-python', + target: '_self', + }, + ] + }, + { + type: 'dropdown', + label: 'SDKs', + position: 'left', + items: [ + { + label: 'Java Slack SDK', + to: 'https://slack.dev/java-slack-sdk/', + target: '_self', + }, + { + label: 'Node Slack SDK', + to: 'https://slack.dev/node-slack-sdk/', + target: '_self', + }, + { + label: 'Python Slack SDK', + to: 'https://slack.dev/python-slack-sdk/', + target: '_self', + }, + { + label: 'Deno Slack SDK', + to: 'https://api.slack.com/automation/quickstart', + target: '_self', + }, + ] + }, + { + type: 'dropdown', + label: 'Community', + position: 'left', + items: [ + { + label: 'Community tools', + to: 'https://slack.dev/community-tools', + target: '_self', + }, + { + label: 'Slack Community', + to: 'https://slackcommunity.com/', + target: '_self', + }, + ] + }, + { + to: 'https://api.slack.com/docs', + label: 'API Docs', + target: '_self', + }, + { + 'aria-label': 'GitHub Repository', + 'className': 'navbar-github-link', + 'href': 'https://github.com/slackapi/node-slack-sdk', + 'position': 'right', + target: '_self', + }, + ], + }, + footer: { + copyright: `

Made with ♡ by Slack and pals like you

`, + }, + prism: { + // switch to alucard when available in prism? + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, + codeblock: { + showGithubLink: true, + githubLinkLabel: 'View on GitHub', + }, + // announcementBar: { + // id: `announcementBar`, + // content: `🎉️ Version 2.26.0 of the developer tools for the Slack automations platform is here! 🎉️ `, + // }, + }), +}; + +export default config; diff --git a/docs/package-lock.json b/docs/package-lock.json new file mode 100644 index 000000000..a07ddad93 --- /dev/null +++ b/docs/package-lock.json @@ -0,0 +1,14730 @@ +{ + "name": "website", + "version": "2024.08.01", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "website", + "version": "2024.08.01", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/plugin-client-redirects": "^3.4.0", + "@docusaurus/preset-classic": "3.4.0", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "docusaurus-theme-github-codeblock": "^2.0.2", + "prism-react-renderer": "^2.3.0", + "react": "^18.0.0", + "react-dom": "^18.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.4.0", + "@docusaurus/types": "3.4.0", + "@tsconfig/recommended": "^1.0.7", + "docusaurus-plugin-typedoc": "^1.0.4", + "typedoc": "^0.26.5", + "typedoc-plugin-markdown": "^4.2.3" + }, + "engines": { + "node": ">=20.0" + } + }, + "node_modules/@algolia/autocomplete-core": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.9.3.tgz", + "integrity": "sha512-009HdfugtGCdC4JdXUbVJClA0q0zh24yyePn+KUGk3rP7j8FEe/m5Yo/z65gn6nP/cM39PxpzqKrL7A6fP6PPw==", + "dependencies": { + "@algolia/autocomplete-plugin-algolia-insights": "1.9.3", + "@algolia/autocomplete-shared": "1.9.3" + } + }, + "node_modules/@algolia/autocomplete-plugin-algolia-insights": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.9.3.tgz", + "integrity": "sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==", + "dependencies": { + "@algolia/autocomplete-shared": "1.9.3" + }, + "peerDependencies": { + "search-insights": ">= 1 < 3" + } + }, + "node_modules/@algolia/autocomplete-preset-algolia": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.9.3.tgz", + "integrity": "sha512-d4qlt6YmrLMYy95n5TB52wtNDr6EgAIPH81dvvvW8UmuWRgxEtY0NJiPwl/h95JtG2vmRM804M0DSwMCNZlzRA==", + "dependencies": { + "@algolia/autocomplete-shared": "1.9.3" + }, + "peerDependencies": { + "@algolia/client-search": ">= 4.9.1 < 6", + "algoliasearch": ">= 4.9.1 < 6" + } + }, + "node_modules/@algolia/autocomplete-shared": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.9.3.tgz", + "integrity": "sha512-Wnm9E4Ye6Rl6sTTqjoymD+l8DjSTHsHboVRYrKgEt8Q7UHm9nYbqhN/i0fhUYA3OAEH7WA8x3jfpnmJm3rKvaQ==", + "peerDependencies": { + "@algolia/client-search": ">= 4.9.1 < 6", + "algoliasearch": ">= 4.9.1 < 6" + } + }, + "node_modules/@algolia/cache-browser-local-storage": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.24.0.tgz", + "integrity": "sha512-t63W9BnoXVrGy9iYHBgObNXqYXM3tYXCjDSHeNwnsc324r4o5UiVKUiAB4THQ5z9U5hTj6qUvwg/Ez43ZD85ww==", + "dependencies": { + "@algolia/cache-common": "4.24.0" + } + }, + "node_modules/@algolia/cache-common": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/cache-common/-/cache-common-4.24.0.tgz", + "integrity": "sha512-emi+v+DmVLpMGhp0V9q9h5CdkURsNmFC+cOS6uK9ndeJm9J4TiqSvPYVu+THUP8P/S08rxf5x2P+p3CfID0Y4g==" + }, + "node_modules/@algolia/cache-in-memory": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/cache-in-memory/-/cache-in-memory-4.24.0.tgz", + "integrity": "sha512-gDrt2so19jW26jY3/MkFg5mEypFIPbPoXsQGQWAi6TrCPsNOSEYepBMPlucqWigsmEy/prp5ug2jy/N3PVG/8w==", + "dependencies": { + "@algolia/cache-common": "4.24.0" + } + }, + "node_modules/@algolia/client-account": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/client-account/-/client-account-4.24.0.tgz", + "integrity": "sha512-adcvyJ3KjPZFDybxlqnf+5KgxJtBjwTPTeyG2aOyoJvx0Y8dUQAEOEVOJ/GBxX0WWNbmaSrhDURMhc+QeevDsA==", + "dependencies": { + "@algolia/client-common": "4.24.0", + "@algolia/client-search": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/client-analytics": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-4.24.0.tgz", + "integrity": "sha512-y8jOZt1OjwWU4N2qr8G4AxXAzaa8DBvyHTWlHzX/7Me1LX8OayfgHexqrsL4vSBcoMmVw2XnVW9MhL+Y2ZDJXg==", + "dependencies": { + "@algolia/client-common": "4.24.0", + "@algolia/client-search": "4.24.0", + "@algolia/requester-common": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/client-common": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/client-common/-/client-common-4.24.0.tgz", + "integrity": "sha512-bc2ROsNL6w6rqpl5jj/UywlIYC21TwSSoFHKl01lYirGMW+9Eek6r02Tocg4gZ8HAw3iBvu6XQiM3BEbmEMoiA==", + "dependencies": { + "@algolia/requester-common": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/client-personalization": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-4.24.0.tgz", + "integrity": "sha512-l5FRFm/yngztweU0HdUzz1rC4yoWCFo3IF+dVIVTfEPg906eZg5BOd1k0K6rZx5JzyyoP4LdmOikfkfGsKVE9w==", + "dependencies": { + "@algolia/client-common": "4.24.0", + "@algolia/requester-common": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/client-search": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-4.24.0.tgz", + "integrity": "sha512-uRW6EpNapmLAD0mW47OXqTP8eiIx5F6qN9/x/7HHO6owL3N1IXqydGwW5nhDFBrV+ldouro2W1VX3XlcUXEFCA==", + "dependencies": { + "@algolia/client-common": "4.24.0", + "@algolia/requester-common": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/events": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@algolia/events/-/events-4.0.1.tgz", + "integrity": "sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==" + }, + "node_modules/@algolia/logger-common": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/logger-common/-/logger-common-4.24.0.tgz", + "integrity": "sha512-LLUNjkahj9KtKYrQhFKCzMx0BY3RnNP4FEtO+sBybCjJ73E8jNdaKJ/Dd8A/VA4imVHP5tADZ8pn5B8Ga/wTMA==" + }, + "node_modules/@algolia/logger-console": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/logger-console/-/logger-console-4.24.0.tgz", + "integrity": "sha512-X4C8IoHgHfiUROfoRCV+lzSy+LHMgkoEEU1BbKcsfnV0i0S20zyy0NLww9dwVHUWNfPPxdMU+/wKmLGYf96yTg==", + "dependencies": { + "@algolia/logger-common": "4.24.0" + } + }, + "node_modules/@algolia/recommend": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/recommend/-/recommend-4.24.0.tgz", + "integrity": "sha512-P9kcgerfVBpfYHDfVZDvvdJv0lEoCvzNlOy2nykyt5bK8TyieYyiD0lguIJdRZZYGre03WIAFf14pgE+V+IBlw==", + "dependencies": { + "@algolia/cache-browser-local-storage": "4.24.0", + "@algolia/cache-common": "4.24.0", + "@algolia/cache-in-memory": "4.24.0", + "@algolia/client-common": "4.24.0", + "@algolia/client-search": "4.24.0", + "@algolia/logger-common": "4.24.0", + "@algolia/logger-console": "4.24.0", + "@algolia/requester-browser-xhr": "4.24.0", + "@algolia/requester-common": "4.24.0", + "@algolia/requester-node-http": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/@algolia/requester-browser-xhr": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.24.0.tgz", + "integrity": "sha512-Z2NxZMb6+nVXSjF13YpjYTdvV3032YTBSGm2vnYvYPA6mMxzM3v5rsCiSspndn9rzIW4Qp1lPHBvuoKJV6jnAA==", + "dependencies": { + "@algolia/requester-common": "4.24.0" + } + }, + "node_modules/@algolia/requester-common": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-common/-/requester-common-4.24.0.tgz", + "integrity": "sha512-k3CXJ2OVnvgE3HMwcojpvY6d9kgKMPRxs/kVohrwF5WMr2fnqojnycZkxPoEg+bXm8fi5BBfFmOqgYztRtHsQA==" + }, + "node_modules/@algolia/requester-node-http": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-4.24.0.tgz", + "integrity": "sha512-JF18yTjNOVYvU/L3UosRcvbPMGT9B+/GQWNWnenIImglzNVGpyzChkXLnrSf6uxwVNO6ESGu6oN8MqcGQcjQJw==", + "dependencies": { + "@algolia/requester-common": "4.24.0" + } + }, + "node_modules/@algolia/transporter": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/@algolia/transporter/-/transporter-4.24.0.tgz", + "integrity": "sha512-86nI7w6NzWxd1Zp9q3413dRshDqAzSbsQjhcDhPIatEFiZrL1/TjnHL8S7jVKFePlIMzDsZWXAXwXzcok9c5oA==", + "dependencies": { + "@algolia/cache-common": "4.24.0", + "@algolia/logger-common": "4.24.0", + "@algolia/requester-common": "4.24.0" + } + }, + "node_modules/@ampproject/remapping": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", + "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", + "dependencies": { + "@babel/highlight": "^7.24.7", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.24.7.tgz", + "integrity": "sha512-qJzAIcv03PyaWqxRgO4mSU3lihncDT296vnyuE2O8uA4w3UHWI4S3hgeZd1L8W1Bft40w9JxJ2b412iDUFFRhw==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.24.7.tgz", + "integrity": "sha512-nykK+LEK86ahTkX/3TgauT0ikKoNCfKHEaZYTUVupJdTLzGNvrblu4u6fa7DhZONAltdf8e662t/abY8idrd/g==", + "dependencies": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.24.7", + "@babel/generator": "^7.24.7", + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helpers": "^7.24.7", + "@babel/parser": "^7.24.7", + "@babel/template": "^7.24.7", + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.24.7.tgz", + "integrity": "sha512-oipXieGC3i45Y1A41t4tAqpnEZWgB/lC6Ehh6+rOviR5XWpTtMmLN+fGjz9vOiNRt0p6RtO6DtD0pdU3vpqdSA==", + "dependencies": { + "@babel/types": "^7.24.7", + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25", + "jsesc": "^2.5.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-annotate-as-pure": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.24.7.tgz", + "integrity": "sha512-BaDeOonYvhdKw+JoMVkAixAAJzG2jVPIwWoKBPdYuY9b452e2rPuI9QPYh3KpofZ3pW2akOmwZLOiOsHMiqRAg==", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-builder-binary-assignment-operator-visitor": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-builder-binary-assignment-operator-visitor/-/helper-builder-binary-assignment-operator-visitor-7.24.7.tgz", + "integrity": "sha512-xZeCVVdwb4MsDBkkyZ64tReWYrLRHlMN72vP7Bdm3OUOuyFZExhsHUUnuWnm2/XOlAJzR0LfPpB56WXZn0X/lA==", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.24.7.tgz", + "integrity": "sha512-ctSdRHBi20qWOfy27RUb4Fhp07KSJ3sXcuSvTrXrc4aG8NSYDo1ici3Vhg9bg69y5bj0Mr1lh0aeEgTvc12rMg==", + "dependencies": { + "@babel/compat-data": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "browserslist": "^4.22.2", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-class-features-plugin": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.24.7.tgz", + "integrity": "sha512-kTkaDl7c9vO80zeX1rJxnuRpEsD5tA81yh11X1gQo+PhSti3JS+7qeZo9U4RHobKRiFPKaGK3svUAeb8D0Q7eg==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-member-expression-to-functions": "^7.24.7", + "@babel/helper-optimise-call-expression": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-class-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.24.7.tgz", + "integrity": "sha512-03TCmXy2FtXJEZfbXDTSqq1fRJArk7lX9DOFC/47VthYcxyIOx+eXQmdo6DOQvrbpIix+KfXwvuXdFDZHxt+rA==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "regexpu-core": "^5.3.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.2.tgz", + "integrity": "sha512-LV76g+C502biUK6AyZ3LK10vDpDyCzZnhZFXkH1L75zHPj68+qc8Zfpx2th+gzwA2MzyK+1g/3EPl62yFnVttQ==", + "dependencies": { + "@babel/helper-compilation-targets": "^7.22.6", + "@babel/helper-plugin-utils": "^7.22.5", + "debug": "^4.1.1", + "lodash.debounce": "^4.0.8", + "resolve": "^1.14.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/helper-environment-visitor": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.24.7.tgz", + "integrity": "sha512-DoiN84+4Gnd0ncbBOM9AZENV4a5ZiL39HYMyZJGZ/AZEykHYdJw0wW3kdcsh9/Kn+BRXHLkkklZ51ecPKmI1CQ==", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-function-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.24.7.tgz", + "integrity": "sha512-FyoJTsj/PEUWu1/TYRiXTIHc8lbw+TDYkZuoE43opPS5TrI7MyONBE1oNvfguEXAD9yhQRrVBnXdXzSLQl9XnA==", + "dependencies": { + "@babel/template": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-hoist-variables": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.24.7.tgz", + "integrity": "sha512-MJJwhkoGy5c4ehfoRyrJ/owKeMl19U54h27YYftT0o2teQ3FJ3nQUf/I3LlJsX4l3qlw7WRXUmiyajvHXoTubQ==", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-member-expression-to-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.24.7.tgz", + "integrity": "sha512-LGeMaf5JN4hAT471eJdBs/GK1DoYIJ5GCtZN/EsL6KUiiDZOvO/eKE11AMZJa2zP4zk4qe9V2O/hxAmkRc8p6w==", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.24.7.tgz", + "integrity": "sha512-8AyH3C+74cgCVVXow/myrynrAGv+nTVg5vKu2nZph9x7RcRwzmh0VFallJuFTZ9mx6u4eSdXZfcOzSqTUm0HCA==", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.24.7.tgz", + "integrity": "sha512-1fuJEwIrp+97rM4RWdO+qrRsZlAeL1lQJoPqtCYWv0NL115XM93hIH4CSRln2w52SqvmY5hqdtauB6QFCDiZNQ==", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-simple-access": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-optimise-call-expression": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.24.7.tgz", + "integrity": "sha512-jKiTsW2xmWwxT1ixIdfXUZp+P5yURx2suzLZr5Hi64rURpDYdMW0pv+Uf17EYk2Rd428Lx4tLsnjGJzYKDM/6A==", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.24.7.tgz", + "integrity": "sha512-Rq76wjt7yz9AAc1KnlRKNAi/dMSVWgDRx43FHoJEbcYU6xOWaE2dVPwcdTukJrjxS65GITyfbvEYHvkirZ6uEg==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-remap-async-to-generator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.24.7.tgz", + "integrity": "sha512-9pKLcTlZ92hNZMQfGCHImUpDOlAgkkpqalWEeftW5FBya75k8Li2ilerxkM/uBEj01iBZXcCIB/bwvDYgWyibA==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-wrap-function": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-replace-supers": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.24.7.tgz", + "integrity": "sha512-qTAxxBM81VEyoAY0TtLrx1oAEJc09ZK67Q9ljQToqCnA+55eNwCORaxlKyu+rNfX86o8OXRUSNUnrtsAZXM9sg==", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-member-expression-to-functions": "^7.24.7", + "@babel/helper-optimise-call-expression": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-simple-access": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.24.7.tgz", + "integrity": "sha512-zBAIvbCMh5Ts+b86r/CjU+4XGYIs+R1j951gxI3KmmxBMhCg4oQMsv6ZXQ64XOm/cvzfU1FmoCyt6+owc5QMYg==", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-skip-transparent-expression-wrappers": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.24.7.tgz", + "integrity": "sha512-IO+DLT3LQUElMbpzlatRASEyQtfhSE0+m465v++3jyyXeBTBUjtVZg28/gHeV5mrTJqvEKhKroBGAvhW+qPHiQ==", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-split-export-declaration": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.24.7.tgz", + "integrity": "sha512-oy5V7pD+UvfkEATUKvIjvIAH/xCzfsFVw7ygW2SI6NClZzquT+mwdTfgfdbUiceh6iQO0CHtCPsyze/MZ2YbAA==", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.7.tgz", + "integrity": "sha512-7MbVt6xrwFQbunH2DNQsAP5sTGxfqQtErvBIvIMi6EQnbgUOuVYanvREcmFrOPhoXBrTtjhhP+lW+o5UfK+tDg==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.24.7.tgz", + "integrity": "sha512-yy1/KvjhV/ZCL+SM7hBrvnZJ3ZuT9OuZgIJAGpPEToANvc3iM6iDvBnRjtElWibHU6n8/LPR/EjX9EtIEYO3pw==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-wrap-function": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.24.7.tgz", + "integrity": "sha512-N9JIYk3TD+1vq/wn77YnJOqMtfWhNewNE+DJV4puD2X7Ew9J4JvrzrFDfTfyv5EgEXVy9/Wt8QiOErzEmv5Ifw==", + "dependencies": { + "@babel/helper-function-name": "^7.24.7", + "@babel/template": "^7.24.7", + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.24.7.tgz", + "integrity": "sha512-NlmJJtvcw72yRJRcnCmGvSi+3jDEg8qFu3z0AFoymmzLx5ERVWyzd9kVXr7Th9/8yIJi2Zc6av4Tqz3wFs8QWg==", + "dependencies": { + "@babel/template": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", + "dependencies": { + "@babel/helper-validator-identifier": "^7.24.7", + "chalk": "^2.4.2", + "js-tokens": "^4.0.0", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/@babel/highlight/node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" + }, + "node_modules/@babel/highlight/node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/@babel/highlight/node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/parser": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.24.7.tgz", + "integrity": "sha512-9uUYRm6OqQrCqQdG1iCBwBPZgN8ciDBro2nIOFaiRz1/BCxaI7CNvQbDHvsArAC7Tw9Hda/B3U+6ui9u4HWXPw==", + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.24.7.tgz", + "integrity": "sha512-TiT1ss81W80eQsN+722OaeQMY/G4yTb4G9JrqeiDADs3N8lbPMGldWi9x8tyqCW5NLx1Jh2AvkE6r6QvEltMMQ==", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.24.7.tgz", + "integrity": "sha512-unaQgZ/iRu/By6tsjMZzpeBZjChYfLYry6HrEXPoz3KmfF0sVBQ1l8zKMQ4xRGLWVsjuvB8nQfjNP/DcfEOCsg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.24.7.tgz", + "integrity": "sha512-+izXIbke1T33mY4MSNnrqhPXDz01WYhEf3yF5NbnUtkiNnm+XBZJl3kNfoK6NKmYlz/D07+l2GWVK/QfDkNCuQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/plugin-transform-optional-chaining": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.13.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.24.7.tgz", + "integrity": "sha512-utA4HuR6F4Vvcr+o4DnjL8fCOlgRFGbeeBEGNg3ZTrLFw6VWG5XmUrvcQ0FjIYMU2ST4XcR2Wsp7t9qOAPnxMg==", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-proposal-private-property-in-object": { + "version": "7.21.0-placeholder-for-preset-env.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", + "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-async-generators": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", + "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-properties": { + "version": "7.12.13", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", + "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.12.13" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-static-block": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", + "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-dynamic-import": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", + "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-export-namespace-from": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-export-namespace-from/-/plugin-syntax-export-namespace-from-7.8.3.tgz", + "integrity": "sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.3" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-assertions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.24.7.tgz", + "integrity": "sha512-Ec3NRUMoi8gskrkBe3fNmEQfxDvY8bgfQpz6jlk/41kX9eUjvpyqWU7PBP/pLAvMaSQjbMNKJmvX57jP+M6bPg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.24.7.tgz", + "integrity": "sha512-hbX+lKKeUMGihnK8nvKqmXBInriT3GVjzXKFriV3YC6APGxMbP8RZNFwy91+hocLXq90Mta+HshoB31802bb8A==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-meta": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", + "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-json-strings": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", + "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.24.7.tgz", + "integrity": "sha512-6ddciUPe/mpMnOKv/U+RSd2vvVy+Yw/JfBB0ZHYjEZt9NLHmCUylNYlsbqCCS1Bffjlb0fCwC9Vqz+sBz6PsiQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-logical-assignment-operators": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", + "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", + "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-numeric-separator": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", + "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-object-rest-spread": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", + "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-catch-binding": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", + "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-chaining": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", + "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-private-property-in-object": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", + "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-top-level-await": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", + "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.24.7.tgz", + "integrity": "sha512-c/+fVeJBB0FeKsFvwytYiUD+LBvhHjGSI0g446PRGdSVGZLRNArBUno2PETbAly3tpiNAQR5XaZ+JslxkotsbA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-unicode-sets-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", + "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-arrow-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.24.7.tgz", + "integrity": "sha512-Dt9LQs6iEY++gXUwY03DNFat5C2NbO48jj+j/bSAz6b3HgPs39qcPiYt77fDObIcFwj3/C2ICX9YMwGflUoSHQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-generator-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.24.7.tgz", + "integrity": "sha512-o+iF77e3u7ZS4AoAuJvapz9Fm001PuD2V3Lp6OSE4FYQke+cSewYtnek+THqGRWyQloRCyvWL1OkyfNEl9vr/g==", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-remap-async-to-generator": "^7.24.7", + "@babel/plugin-syntax-async-generators": "^7.8.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-to-generator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.24.7.tgz", + "integrity": "sha512-SQY01PcJfmQ+4Ash7NE+rpbLFbmqA2GPIgqzxfFTL4t1FKRq4zTms/7htKpoCUI9OcFYgzqfmCdH53s6/jn5fA==", + "dependencies": { + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-remap-async-to-generator": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoped-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.24.7.tgz", + "integrity": "sha512-yO7RAz6EsVQDaBH18IDJcMB1HnrUn2FJ/Jslc/WtPPWcjhpUJXU/rjbwmluzp7v/ZzWcEhTMXELnnsz8djWDwQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoping": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.24.7.tgz", + "integrity": "sha512-Nd5CvgMbWc+oWzBsuaMcbwjJWAcp5qzrbg69SZdHSP7AMY0AbWFqFO0WTFCA1jxhMCwodRwvRec8k0QUbZk7RQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.24.7.tgz", + "integrity": "sha512-vKbfawVYayKcSeSR5YYzzyXvsDFWU2mD8U5TFeXtbCPLFUqe7GyCgvO6XDHzje862ODrOwy6WCPmKeWHbCFJ4w==", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-static-block": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.24.7.tgz", + "integrity": "sha512-HMXK3WbBPpZQufbMG4B46A90PkuuhN9vBCb5T8+VAHqvAqvcLi+2cKoukcpmUYkszLhScU3l1iudhrks3DggRQ==", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-class-static-block": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0" + } + }, + "node_modules/@babel/plugin-transform-classes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.24.7.tgz", + "integrity": "sha512-CFbbBigp8ln4FU6Bpy6g7sE8B/WmCmzvivzUC6xDAdWVsjYTXijpuuGJmYkAaoWAzcItGKT3IOAbxRItZ5HTjw==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-computed-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.24.7.tgz", + "integrity": "sha512-25cS7v+707Gu6Ds2oY6tCkUwsJ9YIDbggd9+cu9jzzDgiNq7hR/8dkzxWfKWnTic26vsI3EsCXNd4iEB6e8esQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/template": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-destructuring": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.24.7.tgz", + "integrity": "sha512-19eJO/8kdCQ9zISOf+SEUJM/bAUIsvY3YDnXZTupUCQ8LgrWnsG/gFB9dvXqdXnRXMAM8fvt7b0CBKQHNGy1mw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dotall-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.24.7.tgz", + "integrity": "sha512-ZOA3W+1RRTSWvyqcMJDLqbchh7U4NRGqwRfFSVbOLS/ePIP4vHB5e8T8eXcuqyN1QkgKyj5wuW0lcS85v4CrSw==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-keys": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.24.7.tgz", + "integrity": "sha512-JdYfXyCRihAe46jUIliuL2/s0x0wObgwwiGxw/UbgJBr20gQBThrokO4nYKgWkD7uBaqM7+9x5TU7NkExZJyzw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dynamic-import": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.24.7.tgz", + "integrity": "sha512-sc3X26PhZQDb3JhORmakcbvkeInvxz+A8oda99lj7J60QRuPZvNAk9wQlTBS1ZynelDrDmTU4pw1tyc5d5ZMUg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-dynamic-import": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.24.7.tgz", + "integrity": "sha512-Rqe/vSc9OYgDajNIK35u7ot+KeCoetqQYFXM4Epf7M7ez3lWlOjrDjrwMei6caCVhfdw+mIKD4cgdGNy5JQotQ==", + "dependencies": { + "@babel/helper-builder-binary-assignment-operator-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-export-namespace-from": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.24.7.tgz", + "integrity": "sha512-v0K9uNYsPL3oXZ/7F9NNIbAj2jv1whUEtyA6aujhekLs56R++JDQuzRcP2/z4WX5Vg/c5lE9uWZA0/iUoFhLTA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-for-of": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.24.7.tgz", + "integrity": "sha512-wo9ogrDG1ITTTBsy46oGiN1dS9A7MROBTcYsfS8DtsImMkHk9JXJ3EWQM6X2SUw4x80uGPlwj0o00Uoc6nEE3g==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-function-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.24.7.tgz", + "integrity": "sha512-U9FcnA821YoILngSmYkW6FjyQe2TyZD5pHt4EVIhmcTkrJw/3KqcrRSxuOo5tFZJi7TE19iDyI1u+weTI7bn2w==", + "dependencies": { + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-json-strings": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.24.7.tgz", + "integrity": "sha512-2yFnBGDvRuxAaE/f0vfBKvtnvvqU8tGpMHqMNpTN2oWMKIR3NqFkjaAgGwawhqK/pIN2T3XdjGPdaG0vDhOBGw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-json-strings": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.24.7.tgz", + "integrity": "sha512-vcwCbb4HDH+hWi8Pqenwnjy+UiklO4Kt1vfspcQYFhJdpthSnW8XvWGyDZWKNVrVbVViI/S7K9PDJZiUmP2fYQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-logical-assignment-operators": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.24.7.tgz", + "integrity": "sha512-4D2tpwlQ1odXmTEIFWy9ELJcZHqrStlzK/dAOWYyxX3zT0iXQB6banjgeOJQXzEc4S0E0a5A+hahxPaEFYftsw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-member-expression-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.24.7.tgz", + "integrity": "sha512-T/hRC1uqrzXMKLQ6UCwMT85S3EvqaBXDGf0FaMf4446Qx9vKwlghvee0+uuZcDUCZU5RuNi4781UQ7R308zzBw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-amd": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.24.7.tgz", + "integrity": "sha512-9+pB1qxV3vs/8Hdmz/CulFB8w2tuu6EB94JZFsjdqxQokwGa9Unap7Bo2gGBGIvPmDIVvQrom7r5m/TCDMURhg==", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-commonjs": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.24.7.tgz", + "integrity": "sha512-iFI8GDxtevHJ/Z22J5xQpVqFLlMNstcLXh994xifFwxxGslr2ZXXLWgtBeLctOD63UFDArdvN6Tg8RFw+aEmjQ==", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-simple-access": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-systemjs": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.24.7.tgz", + "integrity": "sha512-GYQE0tW7YoaN13qFh3O1NCY4MPkUiAH3fiF7UcV/I3ajmDKEdG3l+UOcbAm4zUE3gnvUU+Eni7XrVKo9eO9auw==", + "dependencies": { + "@babel/helper-hoist-variables": "^7.24.7", + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-umd": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.24.7.tgz", + "integrity": "sha512-3aytQvqJ/h9z4g8AsKPLvD4Zqi2qT+L3j7XoFFu1XBlZWEl2/1kWnhmAbxpLgPrHSY0M6UA02jyTiwUVtiKR6A==", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.24.7.tgz", + "integrity": "sha512-/jr7h/EWeJtk1U/uz2jlsCioHkZk1JJZVcc8oQsJ1dUlaJD83f4/6Zeh2aHt9BIFokHIsSeDfhUmju0+1GPd6g==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-new-target": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.24.7.tgz", + "integrity": "sha512-RNKwfRIXg4Ls/8mMTza5oPF5RkOW8Wy/WgMAp1/F1yZ8mMbtwXW+HDoJiOsagWrAhI5f57Vncrmr9XeT4CVapA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.24.7.tgz", + "integrity": "sha512-Ts7xQVk1OEocqzm8rHMXHlxvsfZ0cEF2yomUqpKENHWMF4zKk175Y4q8H5knJes6PgYad50uuRmt3UJuhBw8pQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-numeric-separator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.24.7.tgz", + "integrity": "sha512-e6q1TiVUzvH9KRvicuxdBTUj4AdKSRwzIyFFnfnezpCfP2/7Qmbb8qbU2j7GODbl4JMkblitCQjKYUaX/qkkwA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-numeric-separator": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-rest-spread": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.24.7.tgz", + "integrity": "sha512-4QrHAr0aXQCEFni2q4DqKLD31n2DL+RxcwnNjDFkSG0eNQ/xCavnRkfCUjsyqGC2OviNJvZOF/mQqZBw7i2C5Q==", + "dependencies": { + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-transform-parameters": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-super": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.24.7.tgz", + "integrity": "sha512-A/vVLwN6lBrMFmMDmPPz0jnE6ZGx7Jq7d6sT/Ev4H65RER6pZ+kczlf1DthF5N0qaPHBsI7UXiE8Zy66nmAovg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-catch-binding": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.24.7.tgz", + "integrity": "sha512-uLEndKqP5BfBbC/5jTwPxLh9kqPWWgzN/f8w6UwAIirAEqiIVJWWY312X72Eub09g5KF9+Zn7+hT7sDxmhRuKA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-chaining": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.24.7.tgz", + "integrity": "sha512-tK+0N9yd4j+x/4hxF3F0e0fu/VdcxU18y5SevtyM/PCFlQvXbR0Zmlo2eBrKtVipGNFzpq56o8WsIIKcJFUCRQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/plugin-syntax-optional-chaining": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-parameters": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.24.7.tgz", + "integrity": "sha512-yGWW5Rr+sQOhK0Ot8hjDJuxU3XLRQGflvT4lhlSY0DFvdb3TwKaY26CJzHtYllU0vT9j58hc37ndFPsqT1SrzA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-methods": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.24.7.tgz", + "integrity": "sha512-COTCOkG2hn4JKGEKBADkA8WNb35TGkkRbI5iT845dB+NyqgO8Hn+ajPbSnIQznneJTa3d30scb6iz/DhH8GsJQ==", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-property-in-object": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.24.7.tgz", + "integrity": "sha512-9z76mxwnwFxMyxZWEgdgECQglF2Q7cFLm0kMf8pGwt+GSJsY0cONKj/UuO4bOH0w/uAel3ekS4ra5CEAyJRmDA==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-property-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.24.7.tgz", + "integrity": "sha512-EMi4MLQSHfd2nrCqQEWxFdha2gBCqU4ZcCng4WBGZ5CJL4bBRW0ptdqqDdeirGZcpALazVVNJqRmsO8/+oNCBA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-constant-elements": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.24.7.tgz", + "integrity": "sha512-7LidzZfUXyfZ8/buRW6qIIHBY8wAZ1OrY9c/wTr8YhZ6vMPo+Uc/CVFLYY1spZrEQlD4w5u8wjqk5NQ3OVqQKA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-display-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.24.7.tgz", + "integrity": "sha512-H/Snz9PFxKsS1JLI4dJLtnJgCJRoo0AUm3chP6NYr+9En1JMKloheEiLIhlp5MDVznWo+H3AAC1Mc8lmUEpsgg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.24.7.tgz", + "integrity": "sha512-+Dj06GDZEFRYvclU6k4bme55GKBEWUmByM/eoKuqg4zTNQHiApWRhQph5fxQB2wAEFvRzL1tOEj1RJ19wJrhoA==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-jsx": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-development": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.24.7.tgz", + "integrity": "sha512-QG9EnzoGn+Qar7rxuW+ZOsbWOt56FvvI93xInqsZDC5fsekx1AlIO4KIJ5M+D0p0SqSH156EpmZyXq630B8OlQ==", + "dependencies": { + "@babel/plugin-transform-react-jsx": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-pure-annotations": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.24.7.tgz", + "integrity": "sha512-PLgBVk3fzbmEjBJ/u8kFzOqS9tUeDjiaWud/rRym/yjCo/M9cASPlnrd2ZmmZpQT40fOOrvR8jh+n8jikrOhNA==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regenerator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.24.7.tgz", + "integrity": "sha512-lq3fvXPdimDrlg6LWBoqj+r/DEWgONuwjuOuQCSYgRroXDH/IdM1C0IZf59fL5cHLpjEH/O6opIRBbqv7ELnuA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "regenerator-transform": "^0.15.2" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-reserved-words": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.24.7.tgz", + "integrity": "sha512-0DUq0pHcPKbjFZCfTss/pGkYMfy3vFWydkUBd9r0GHpIyfs2eCDENvqadMycRS9wZCXR41wucAfJHJmwA0UmoQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.24.7.tgz", + "integrity": "sha512-YqXjrk4C+a1kZjewqt+Mmu2UuV1s07y8kqcUf4qYLnoqemhR4gRQikhdAhSVJioMjVTu6Mo6pAbaypEA3jY6fw==", + "dependencies": { + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "babel-plugin-polyfill-corejs2": "^0.4.10", + "babel-plugin-polyfill-corejs3": "^0.10.1", + "babel-plugin-polyfill-regenerator": "^0.6.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.24.7.tgz", + "integrity": "sha512-KsDsevZMDsigzbA09+vacnLpmPH4aWjcZjXdyFKGzpplxhbeB4wYtury3vglQkg6KM/xEPKt73eCjPPf1PgXBA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-spread": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.24.7.tgz", + "integrity": "sha512-x96oO0I09dgMDxJaANcRyD4ellXFLLiWhuwDxKZX5g2rWP1bTPkBSwCYv96VDXVT1bD9aPj8tppr5ITIh8hBng==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-sticky-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.24.7.tgz", + "integrity": "sha512-kHPSIJc9v24zEml5geKg9Mjx5ULpfncj0wRpYtxbvKyTtHCYDkVE3aHQ03FrpEo4gEe2vrJJS1Y9CJTaThA52g==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-template-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.24.7.tgz", + "integrity": "sha512-AfDTQmClklHCOLxtGoP7HkeMw56k1/bTQjwsfhL6pppo/M4TOBSq+jjBUBLmV/4oeFg4GWMavIl44ZeCtmmZTw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typeof-symbol": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.24.7.tgz", + "integrity": "sha512-VtR8hDy7YLB7+Pet9IarXjg/zgCMSF+1mNS/EQEiEaUPoFXCVsHG64SIxcaaI2zJgRiv+YmgaQESUfWAdbjzgg==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.24.7.tgz", + "integrity": "sha512-iLD3UNkgx2n/HrjBesVbYX6j0yqn/sJktvbtKKgcaLIQ4bTTQ8obAypc1VpyHPD2y4Phh9zHOaAt8e/L14wCpw==", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-typescript": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-escapes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.24.7.tgz", + "integrity": "sha512-U3ap1gm5+4edc2Q/P+9VrBNhGkfnf+8ZqppY71Bo/pzZmXhhLdqgaUl6cuB07O1+AQJtCLfaOmswiNbSQ9ivhw==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-property-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.24.7.tgz", + "integrity": "sha512-uH2O4OV5M9FZYQrwc7NdVmMxQJOCCzFeYudlZSzUAHRFeOujQefa92E74TQDVskNHCzOXoigEuoyzHDhaEaK5w==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.24.7.tgz", + "integrity": "sha512-hlQ96MBZSAXUq7ltkjtu3FJCCSMx/j629ns3hA3pXnBXjanNP0LHi+JpPeA81zaWgVK1VGH95Xuy7u0RyQ8kMg==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-sets-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.24.7.tgz", + "integrity": "sha512-2G8aAvF4wy1w/AGZkemprdGMRg5o6zPNhbHVImRz3lss55TYCBd6xStN19rt8XJHq20sqV0JbyWjOWwQRwV/wg==", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/preset-env": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.24.7.tgz", + "integrity": "sha512-1YZNsc+y6cTvWlDHidMBsQZrZfEFjRIo/BZCT906PMdzOyXtSLTgqGdrpcuTDCXyd11Am5uQULtDIcCfnTc8fQ==", + "dependencies": { + "@babel/compat-data": "^7.24.7", + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.24.7", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.24.7", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.24.7", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.24.7", + "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-class-properties": "^7.12.13", + "@babel/plugin-syntax-class-static-block": "^7.14.5", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3", + "@babel/plugin-syntax-import-assertions": "^7.24.7", + "@babel/plugin-syntax-import-attributes": "^7.24.7", + "@babel/plugin-syntax-import-meta": "^7.10.4", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.10.4", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5", + "@babel/plugin-syntax-top-level-await": "^7.14.5", + "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", + "@babel/plugin-transform-arrow-functions": "^7.24.7", + "@babel/plugin-transform-async-generator-functions": "^7.24.7", + "@babel/plugin-transform-async-to-generator": "^7.24.7", + "@babel/plugin-transform-block-scoped-functions": "^7.24.7", + "@babel/plugin-transform-block-scoping": "^7.24.7", + "@babel/plugin-transform-class-properties": "^7.24.7", + "@babel/plugin-transform-class-static-block": "^7.24.7", + "@babel/plugin-transform-classes": "^7.24.7", + "@babel/plugin-transform-computed-properties": "^7.24.7", + "@babel/plugin-transform-destructuring": "^7.24.7", + "@babel/plugin-transform-dotall-regex": "^7.24.7", + "@babel/plugin-transform-duplicate-keys": "^7.24.7", + "@babel/plugin-transform-dynamic-import": "^7.24.7", + "@babel/plugin-transform-exponentiation-operator": "^7.24.7", + "@babel/plugin-transform-export-namespace-from": "^7.24.7", + "@babel/plugin-transform-for-of": "^7.24.7", + "@babel/plugin-transform-function-name": "^7.24.7", + "@babel/plugin-transform-json-strings": "^7.24.7", + "@babel/plugin-transform-literals": "^7.24.7", + "@babel/plugin-transform-logical-assignment-operators": "^7.24.7", + "@babel/plugin-transform-member-expression-literals": "^7.24.7", + "@babel/plugin-transform-modules-amd": "^7.24.7", + "@babel/plugin-transform-modules-commonjs": "^7.24.7", + "@babel/plugin-transform-modules-systemjs": "^7.24.7", + "@babel/plugin-transform-modules-umd": "^7.24.7", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.24.7", + "@babel/plugin-transform-new-target": "^7.24.7", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.24.7", + "@babel/plugin-transform-numeric-separator": "^7.24.7", + "@babel/plugin-transform-object-rest-spread": "^7.24.7", + "@babel/plugin-transform-object-super": "^7.24.7", + "@babel/plugin-transform-optional-catch-binding": "^7.24.7", + "@babel/plugin-transform-optional-chaining": "^7.24.7", + "@babel/plugin-transform-parameters": "^7.24.7", + "@babel/plugin-transform-private-methods": "^7.24.7", + "@babel/plugin-transform-private-property-in-object": "^7.24.7", + "@babel/plugin-transform-property-literals": "^7.24.7", + "@babel/plugin-transform-regenerator": "^7.24.7", + "@babel/plugin-transform-reserved-words": "^7.24.7", + "@babel/plugin-transform-shorthand-properties": "^7.24.7", + "@babel/plugin-transform-spread": "^7.24.7", + "@babel/plugin-transform-sticky-regex": "^7.24.7", + "@babel/plugin-transform-template-literals": "^7.24.7", + "@babel/plugin-transform-typeof-symbol": "^7.24.7", + "@babel/plugin-transform-unicode-escapes": "^7.24.7", + "@babel/plugin-transform-unicode-property-regex": "^7.24.7", + "@babel/plugin-transform-unicode-regex": "^7.24.7", + "@babel/plugin-transform-unicode-sets-regex": "^7.24.7", + "@babel/preset-modules": "0.1.6-no-external-plugins", + "babel-plugin-polyfill-corejs2": "^0.4.10", + "babel-plugin-polyfill-corejs3": "^0.10.4", + "babel-plugin-polyfill-regenerator": "^0.6.1", + "core-js-compat": "^3.31.0", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-env/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/preset-modules": { + "version": "0.1.6-no-external-plugins", + "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", + "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@babel/types": "^7.4.4", + "esutils": "^2.0.2" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-react": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.24.7.tgz", + "integrity": "sha512-AAH4lEkpmzFWrGVlHaxJB7RLH21uPQ9+He+eFLWHmF9IuFQVugz8eAsamaW0DXRrTfco5zj1wWtpdcXJUOfsag==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-transform-react-display-name": "^7.24.7", + "@babel/plugin-transform-react-jsx": "^7.24.7", + "@babel/plugin-transform-react-jsx-development": "^7.24.7", + "@babel/plugin-transform-react-pure-annotations": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.24.7.tgz", + "integrity": "sha512-SyXRe3OdWwIwalxDg5UtJnJQO+YPcTfwiIY2B0Xlddh9o7jpWLvv8X1RthIeDOxQ+O1ML5BLPCONToObyVQVuQ==", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-syntax-jsx": "^7.24.7", + "@babel/plugin-transform-modules-commonjs": "^7.24.7", + "@babel/plugin-transform-typescript": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@babel/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==" + }, + "node_modules/@babel/runtime": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.24.7.tgz", + "integrity": "sha512-UwgBRMjJP+xv857DCngvqXI3Iq6J4v0wXmwc6sapg+zyhbwmQX67LUEFrkK5tbyJ30jGuG3ZvWpBiB9LCy1kWw==", + "dependencies": { + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime-corejs3": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.24.7.tgz", + "integrity": "sha512-eytSX6JLBY6PVAeQa2bFlDx/7Mmln/gaEpsit5a3WEvjGfiIytEsgAwuIXCPM0xvw0v0cJn3ilq0/TvXrW0kgA==", + "dependencies": { + "core-js-pure": "^3.30.2", + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.24.7.tgz", + "integrity": "sha512-jYqfPrU9JTF0PmPy1tLYHW4Mp4KlgxJD9l2nP9fD6yT/ICi554DmrWBAEYpIelzjHf1msDP3PxJIRt/nFNfBig==", + "dependencies": { + "@babel/code-frame": "^7.24.7", + "@babel/parser": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.24.7.tgz", + "integrity": "sha512-yb65Ed5S/QAcewNPh0nZczy9JdYXkkAbIsEo+P7BE7yO3txAY30Y/oPa3QkQ5It3xVG2kpKMg9MsdxZaO31uKA==", + "dependencies": { + "@babel/code-frame": "^7.24.7", + "@babel/generator": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-hoist-variables": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "@babel/parser": "^7.24.7", + "@babel/types": "^7.24.7", + "debug": "^4.3.1", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.24.7.tgz", + "integrity": "sha512-XEFXSlxiG5td2EJRe8vOmRbaXVgfcBlszKujvVmWIK/UpywWljQCfzAv3RQCGujWQ1RD4YYWEAqDXfuJiy8f5Q==", + "dependencies": { + "@babel/helper-string-parser": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7", + "to-fast-properties": "^2.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@colors/colors": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", + "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", + "optional": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@discoveryjs/json-ext": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz", + "integrity": "sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==", + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@docsearch/css": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-3.6.0.tgz", + "integrity": "sha512-+sbxb71sWre+PwDK7X2T8+bhS6clcVMLwBPznX45Qu6opJcgRjAp7gYSDzVFp187J+feSj5dNBN1mJoi6ckkUQ==" + }, + "node_modules/@docsearch/react": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/@docsearch/react/-/react-3.6.0.tgz", + "integrity": "sha512-HUFut4ztcVNmqy9gp/wxNbC7pTOHhgVVkHVGCACTuLhUKUhKAF9KYHJtMiLUJxEqiFLQiuri1fWF8zqwM/cu1w==", + "dependencies": { + "@algolia/autocomplete-core": "1.9.3", + "@algolia/autocomplete-preset-algolia": "1.9.3", + "@docsearch/css": "3.6.0", + "algoliasearch": "^4.19.1" + }, + "peerDependencies": { + "@types/react": ">= 16.8.0 < 19.0.0", + "react": ">= 16.8.0 < 19.0.0", + "react-dom": ">= 16.8.0 < 19.0.0", + "search-insights": ">= 1 < 3" + }, + "peerDependenciesMeta": { + "@types/react": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "search-insights": { + "optional": true + } + } + }, + "node_modules/@docusaurus/core": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/core/-/core-3.4.0.tgz", + "integrity": "sha512-g+0wwmN2UJsBqy2fQRQ6fhXruoEa62JDeEa5d8IdTJlMoaDaEDfHh7WjwGRn4opuTQWpjAwP/fbcgyHKlE+64w==", + "dependencies": { + "@babel/core": "^7.23.3", + "@babel/generator": "^7.23.3", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-transform-runtime": "^7.22.9", + "@babel/preset-env": "^7.22.9", + "@babel/preset-react": "^7.22.5", + "@babel/preset-typescript": "^7.22.5", + "@babel/runtime": "^7.22.6", + "@babel/runtime-corejs3": "^7.22.6", + "@babel/traverse": "^7.22.8", + "@docusaurus/cssnano-preset": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "autoprefixer": "^10.4.14", + "babel-loader": "^9.1.3", + "babel-plugin-dynamic-import-node": "^2.3.3", + "boxen": "^6.2.1", + "chalk": "^4.1.2", + "chokidar": "^3.5.3", + "clean-css": "^5.3.2", + "cli-table3": "^0.6.3", + "combine-promises": "^1.1.0", + "commander": "^5.1.0", + "copy-webpack-plugin": "^11.0.0", + "core-js": "^3.31.1", + "css-loader": "^6.8.1", + "css-minimizer-webpack-plugin": "^5.0.1", + "cssnano": "^6.1.2", + "del": "^6.1.1", + "detect-port": "^1.5.1", + "escape-html": "^1.0.3", + "eta": "^2.2.0", + "eval": "^0.1.8", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "html-minifier-terser": "^7.2.0", + "html-tags": "^3.3.1", + "html-webpack-plugin": "^5.5.3", + "leven": "^3.1.0", + "lodash": "^4.17.21", + "mini-css-extract-plugin": "^2.7.6", + "p-map": "^4.0.0", + "postcss": "^8.4.26", + "postcss-loader": "^7.3.3", + "prompts": "^2.4.2", + "react-dev-utils": "^12.0.1", + "react-helmet-async": "^1.3.0", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0", + "react-loadable-ssr-addon-v5-slorber": "^1.0.1", + "react-router": "^5.3.4", + "react-router-config": "^5.1.1", + "react-router-dom": "^5.3.4", + "rtl-detect": "^1.0.4", + "semver": "^7.5.4", + "serve-handler": "^6.1.5", + "shelljs": "^0.8.5", + "terser-webpack-plugin": "^5.3.9", + "tslib": "^2.6.0", + "update-notifier": "^6.0.2", + "url-loader": "^4.1.1", + "webpack": "^5.88.1", + "webpack-bundle-analyzer": "^4.9.0", + "webpack-dev-server": "^4.15.1", + "webpack-merge": "^5.9.0", + "webpackbar": "^5.0.2" + }, + "bin": { + "docusaurus": "bin/docusaurus.mjs" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/cssnano-preset": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/cssnano-preset/-/cssnano-preset-3.4.0.tgz", + "integrity": "sha512-qwLFSz6v/pZHy/UP32IrprmH5ORce86BGtN0eBtG75PpzQJAzp9gefspox+s8IEOr0oZKuQ/nhzZ3xwyc3jYJQ==", + "dependencies": { + "cssnano-preset-advanced": "^6.1.2", + "postcss": "^8.4.38", + "postcss-sort-media-queries": "^5.2.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + } + }, + "node_modules/@docusaurus/logger": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/logger/-/logger-3.4.0.tgz", + "integrity": "sha512-bZwkX+9SJ8lB9kVRkXw+xvHYSMGG4bpYHKGXeXFvyVc79NMeeBSGgzd4TQLHH+DYeOJoCdl8flrFJVxlZ0wo/Q==", + "dependencies": { + "chalk": "^4.1.2", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + } + }, + "node_modules/@docusaurus/mdx-loader": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/mdx-loader/-/mdx-loader-3.4.0.tgz", + "integrity": "sha512-kSSbrrk4nTjf4d+wtBA9H+FGauf2gCax89kV8SUSJu3qaTdSIKdWERlngsiHaCFgZ7laTJ8a67UFf+xlFPtuTw==", + "dependencies": { + "@docusaurus/logger": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "@mdx-js/mdx": "^3.0.0", + "@slorber/remark-comment": "^1.0.0", + "escape-html": "^1.0.3", + "estree-util-value-to-estree": "^3.0.1", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "image-size": "^1.0.2", + "mdast-util-mdx": "^3.0.0", + "mdast-util-to-string": "^4.0.0", + "rehype-raw": "^7.0.0", + "remark-directive": "^3.0.0", + "remark-emoji": "^4.0.0", + "remark-frontmatter": "^5.0.0", + "remark-gfm": "^4.0.0", + "stringify-object": "^3.3.0", + "tslib": "^2.6.0", + "unified": "^11.0.3", + "unist-util-visit": "^5.0.0", + "url-loader": "^4.1.1", + "vfile": "^6.0.1", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/module-type-aliases": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/module-type-aliases/-/module-type-aliases-3.4.0.tgz", + "integrity": "sha512-A1AyS8WF5Bkjnb8s+guTDuYmUiwJzNrtchebBHpc0gz0PyHJNMaybUlSrmJjHVcGrya0LKI4YcR3lBDQfXRYLw==", + "dependencies": { + "@docusaurus/types": "3.4.0", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "@types/react-router-dom": "*", + "react-helmet-async": "*", + "react-loadable": "npm:@docusaurus/react-loadable@6.0.0" + }, + "peerDependencies": { + "react": "*", + "react-dom": "*" + } + }, + "node_modules/@docusaurus/plugin-client-redirects": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.4.0.tgz", + "integrity": "sha512-Pr8kyh/+OsmYCvdZhc60jy/FnrY6flD2TEAhl4rJxeVFxnvvRgEhoaIVX8q9MuJmaQoh6frPk94pjs7/6YgBDQ==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-blog": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.4.0.tgz", + "integrity": "sha512-vv6ZAj78ibR5Jh7XBUT4ndIjmlAxkijM3Sx5MAAzC1gyv0vupDQNhzuFg1USQmQVj3P5I6bquk12etPV3LJ+Xw==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "cheerio": "^1.0.0-rc.12", + "feed": "^4.2.2", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "reading-time": "^1.5.0", + "srcset": "^4.0.0", + "tslib": "^2.6.0", + "unist-util-visit": "^5.0.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-docs": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.4.0.tgz", + "integrity": "sha512-HkUCZffhBo7ocYheD9oZvMcDloRnGhBMOZRyVcAQRFmZPmNqSyISlXA1tQCIxW+r478fty97XXAGjNYzBjpCsg==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/module-type-aliases": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "@types/react-router-config": "^5.0.7", + "combine-promises": "^1.1.0", + "fs-extra": "^11.1.1", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "tslib": "^2.6.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-content-pages": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-pages/-/plugin-content-pages-3.4.0.tgz", + "integrity": "sha512-h2+VN/0JjpR8fIkDEAoadNjfR3oLzB+v1qSXbIAKjQ46JAHx3X22n9nqS+BWSQnTnp1AjkjSvZyJMekmcwxzxg==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "fs-extra": "^11.1.1", + "tslib": "^2.6.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-debug": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-debug/-/plugin-debug-3.4.0.tgz", + "integrity": "sha512-uV7FDUNXGyDSD3PwUaf5YijX91T5/H9SX4ErEcshzwgzWwBtK37nUWPU3ZLJfeTavX3fycTOqk9TglpOLaWkCg==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "fs-extra": "^11.1.1", + "react-json-view-lite": "^1.2.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-analytics": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-analytics/-/plugin-google-analytics-3.4.0.tgz", + "integrity": "sha512-mCArluxEGi3cmYHqsgpGGt3IyLCrFBxPsxNZ56Mpur0xSlInnIHoeLDH7FvVVcPJRPSQ9/MfRqLsainRw+BojA==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-gtag": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-gtag/-/plugin-google-gtag-3.4.0.tgz", + "integrity": "sha512-Dsgg6PLAqzZw5wZ4QjUYc8Z2KqJqXxHxq3vIoyoBWiLEEfigIs7wHR+oiWUQy3Zk9MIk6JTYj7tMoQU0Jm3nqA==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "@types/gtag.js": "^0.0.12", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-google-tag-manager": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-google-tag-manager/-/plugin-google-tag-manager-3.4.0.tgz", + "integrity": "sha512-O9tX1BTwxIhgXpOLpFDueYA9DWk69WCbDRrjYoMQtFHSkTyE7RhNgyjSPREUWJb9i+YUg3OrsvrBYRl64FCPCQ==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/plugin-sitemap": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-sitemap/-/plugin-sitemap-3.4.0.tgz", + "integrity": "sha512-+0VDvx9SmNrFNgwPoeoCha+tRoAjopwT0+pYO1xAbyLcewXSemq+eLxEa46Q1/aoOaJQ0qqHELuQM7iS2gp33Q==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "fs-extra": "^11.1.1", + "sitemap": "^7.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/preset-classic": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/preset-classic/-/preset-classic-3.4.0.tgz", + "integrity": "sha512-Ohj6KB7siKqZaQhNJVMBBUzT3Nnp6eTKqO+FXO3qu/n1hJl3YLwVKTWBg28LF7MWrKu46UuYavwMRxud0VyqHg==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/plugin-content-blog": "3.4.0", + "@docusaurus/plugin-content-docs": "3.4.0", + "@docusaurus/plugin-content-pages": "3.4.0", + "@docusaurus/plugin-debug": "3.4.0", + "@docusaurus/plugin-google-analytics": "3.4.0", + "@docusaurus/plugin-google-gtag": "3.4.0", + "@docusaurus/plugin-google-tag-manager": "3.4.0", + "@docusaurus/plugin-sitemap": "3.4.0", + "@docusaurus/theme-classic": "3.4.0", + "@docusaurus/theme-common": "3.4.0", + "@docusaurus/theme-search-algolia": "3.4.0", + "@docusaurus/types": "3.4.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/theme-classic": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-classic/-/theme-classic-3.4.0.tgz", + "integrity": "sha512-0IPtmxsBYv2adr1GnZRdMkEQt1YW6tpzrUPj02YxNpvJ5+ju4E13J5tB4nfdaen/tfR1hmpSPlTFPvTf4kwy8Q==", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/module-type-aliases": "3.4.0", + "@docusaurus/plugin-content-blog": "3.4.0", + "@docusaurus/plugin-content-docs": "3.4.0", + "@docusaurus/plugin-content-pages": "3.4.0", + "@docusaurus/theme-common": "3.4.0", + "@docusaurus/theme-translations": "3.4.0", + "@docusaurus/types": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "copy-text-to-clipboard": "^3.2.0", + "infima": "0.2.0-alpha.43", + "lodash": "^4.17.21", + "nprogress": "^0.2.0", + "postcss": "^8.4.26", + "prism-react-renderer": "^2.3.0", + "prismjs": "^1.29.0", + "react-router-dom": "^5.3.4", + "rtlcss": "^4.1.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/theme-common": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.4.0.tgz", + "integrity": "sha512-0A27alXuv7ZdCg28oPE8nH/Iz73/IUejVaCazqu9elS4ypjiLhK3KfzdSQBnL/g7YfHSlymZKdiOHEo8fJ0qMA==", + "dependencies": { + "@docusaurus/mdx-loader": "3.4.0", + "@docusaurus/module-type-aliases": "3.4.0", + "@docusaurus/plugin-content-blog": "3.4.0", + "@docusaurus/plugin-content-docs": "3.4.0", + "@docusaurus/plugin-content-pages": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router-config": "*", + "clsx": "^2.0.0", + "parse-numeric-range": "^1.3.0", + "prism-react-renderer": "^2.3.0", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/theme-search-algolia": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-search-algolia/-/theme-search-algolia-3.4.0.tgz", + "integrity": "sha512-aiHFx7OCw4Wck1z6IoShVdUWIjntC8FHCw9c5dR8r3q4Ynh+zkS8y2eFFunN/DL6RXPzpnvKCg3vhLQYJDmT9Q==", + "dependencies": { + "@docsearch/react": "^3.5.2", + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/plugin-content-docs": "3.4.0", + "@docusaurus/theme-common": "3.4.0", + "@docusaurus/theme-translations": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "algoliasearch": "^4.18.0", + "algoliasearch-helper": "^3.13.3", + "clsx": "^2.0.0", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0", + "utility-types": "^3.10.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/theme-translations": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/theme-translations/-/theme-translations-3.4.0.tgz", + "integrity": "sha512-zSxCSpmQCCdQU5Q4CnX/ID8CSUUI3fvmq4hU/GNP/XoAWtXo9SAVnM3TzpU8Gb//H3WCsT8mJcTfyOk3d9ftNg==", + "dependencies": { + "fs-extra": "^11.1.1", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + } + }, + "node_modules/@docusaurus/types": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/types/-/types-3.4.0.tgz", + "integrity": "sha512-4jcDO8kXi5Cf9TcyikB/yKmz14f2RZ2qTRerbHAsS+5InE9ZgSLBNLsewtFTcTOXSVcbU3FoGOzcNWAmU1TR0A==", + "dependencies": { + "@mdx-js/mdx": "^3.0.0", + "@types/history": "^4.7.11", + "@types/react": "*", + "commander": "^5.1.0", + "joi": "^17.9.2", + "react-helmet-async": "^1.3.0", + "utility-types": "^3.10.0", + "webpack": "^5.88.1", + "webpack-merge": "^5.9.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, + "node_modules/@docusaurus/utils": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.4.0.tgz", + "integrity": "sha512-fRwnu3L3nnWaXOgs88BVBmG1yGjcQqZNHG+vInhEa2Sz2oQB+ZjbEMO5Rh9ePFpZ0YDiDUhpaVjwmS+AU2F14g==", + "dependencies": { + "@docusaurus/logger": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@svgr/webpack": "^8.1.0", + "escape-string-regexp": "^4.0.0", + "file-loader": "^6.2.0", + "fs-extra": "^11.1.1", + "github-slugger": "^1.5.0", + "globby": "^11.1.0", + "gray-matter": "^4.0.3", + "jiti": "^1.20.0", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "micromatch": "^4.0.5", + "prompts": "^2.4.2", + "resolve-pathname": "^3.0.0", + "shelljs": "^0.8.5", + "tslib": "^2.6.0", + "url-loader": "^4.1.1", + "utility-types": "^3.10.0", + "webpack": "^5.88.1" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "@docusaurus/types": "*" + }, + "peerDependenciesMeta": { + "@docusaurus/types": { + "optional": true + } + } + }, + "node_modules/@docusaurus/utils-common": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-common/-/utils-common-3.4.0.tgz", + "integrity": "sha512-NVx54Wr4rCEKsjOH5QEVvxIqVvm+9kh7q8aYTU5WzUU9/Hctd6aTrcZ3G0Id4zYJ+AeaG5K5qHA4CY5Kcm2iyQ==", + "dependencies": { + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "@docusaurus/types": "*" + }, + "peerDependenciesMeta": { + "@docusaurus/types": { + "optional": true + } + } + }, + "node_modules/@docusaurus/utils-validation": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/utils-validation/-/utils-validation-3.4.0.tgz", + "integrity": "sha512-hYQ9fM+AXYVTWxJOT1EuNaRnrR2WGpRdLDQG07O8UOpsvCPWUVOeo26Rbm0JWY2sGLfzAb+tvJ62yF+8F+TV0g==", + "dependencies": { + "@docusaurus/logger": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "fs-extra": "^11.2.0", + "joi": "^17.9.2", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + } + }, + "node_modules/@hapi/hoek": { + "version": "9.3.0", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz", + "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==" + }, + "node_modules/@hapi/topo": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-5.1.0.tgz", + "integrity": "sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@jest/schemas": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz", + "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==", + "dependencies": { + "@sinclair/typebox": "^0.27.8" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jest/types": { + "version": "29.6.3", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.6.3.tgz", + "integrity": "sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==", + "dependencies": { + "@jest/schemas": "^29.6.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^17.0.8", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", + "dependencies": { + "@jridgewell/set-array": "^1.2.1", + "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/set-array": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/source-map": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", + "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@leichtgewicht/ip-codec": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz", + "integrity": "sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw==" + }, + "node_modules/@mdx-js/mdx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@mdx-js/mdx/-/mdx-3.0.1.tgz", + "integrity": "sha512-eIQ4QTrOWyL3LWEe/bu6Taqzq2HQvHcyTMaOrI95P2/LmJE7AsfPfgJGuFLPVqBUE1BC1rik3VIhU+s9u72arA==", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdx": "^2.0.0", + "collapse-white-space": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-build-jsx": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-util-to-js": "^2.0.0", + "estree-walker": "^3.0.0", + "hast-util-to-estree": "^3.0.0", + "hast-util-to-jsx-runtime": "^2.0.0", + "markdown-extensions": "^2.0.0", + "periscopic": "^3.0.0", + "remark-mdx": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-rehype": "^11.0.0", + "source-map": "^0.7.0", + "unified": "^11.0.0", + "unist-util-position-from-estree": "^2.0.0", + "unist-util-stringify-position": "^4.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/@mdx-js/react": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.0.1.tgz", + "integrity": "sha512-9ZrPIU4MGf6et1m1ov3zKf+q9+deetI51zprKB1D/z3NOb+rUxxtEl3mCjW5wTGh6VhRdwPueh1oRzi6ezkA8A==", + "dependencies": { + "@types/mdx": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + }, + "peerDependencies": { + "@types/react": ">=16", + "react": ">=16" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@pnpm/config.env-replace": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", + "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", + "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { + "version": "4.2.10", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", + "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==" + }, + "node_modules/@pnpm/npm-conf": { + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-2.2.2.tgz", + "integrity": "sha512-UA91GwWPhFExt3IizW6bOeY/pQ0BkuNwKjk9iQW9KqxluGCrg4VenZ0/L+2Y0+ZOtme72EVvg6v0zo3AMQRCeA==", + "dependencies": { + "@pnpm/config.env-replace": "^1.1.0", + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@polka/url": { + "version": "1.0.0-next.25", + "resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.25.tgz", + "integrity": "sha512-j7P6Rgr3mmtdkeDGTe0E/aYyWEWVtc5yFXtHCRHs28/jptDEWfaVOc5T7cblqy1XKPPfCxJc/8DwQ5YgLOZOVQ==" + }, + "node_modules/@shikijs/core": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.12.1.tgz", + "integrity": "sha512-biCz/mnkMktImI6hMfMX3H9kOeqsInxWEyCHbSlL8C/2TR1FqfmGxTLRNwYCKsyCyxWLbB8rEqXRVZuyxuLFmA==", + "dev": true, + "dependencies": { + "@types/hast": "^3.0.4" + } + }, + "node_modules/@sideway/address": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz", + "integrity": "sha512-IqO/DUQHUkPeixNQ8n0JA6102hT9CmaljNTPmQ1u8MEhBo/R4Q8eKLN/vGZxuebwOroDB4cbpjheD4+/sKFK4Q==", + "dependencies": { + "@hapi/hoek": "^9.0.0" + } + }, + "node_modules/@sideway/formula": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@sideway/formula/-/formula-3.0.1.tgz", + "integrity": "sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==" + }, + "node_modules/@sideway/pinpoint": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz", + "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==" + }, + "node_modules/@sinclair/typebox": { + "version": "0.27.8", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", + "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==" + }, + "node_modules/@sindresorhus/is": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", + "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/@slorber/remark-comment": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@slorber/remark-comment/-/remark-comment-1.0.0.tgz", + "integrity": "sha512-RCE24n7jsOj1M0UPvIQCHTe7fI0sFL4S2nwKVWwHyVr/wI/H8GosgsJGyhnsZoGFnD/P2hLf1mSbrrgSLN93NA==", + "dependencies": { + "micromark-factory-space": "^1.0.0", + "micromark-util-character": "^1.1.0", + "micromark-util-symbol": "^1.0.1" + } + }, + "node_modules/@svgr/babel-plugin-add-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-b9MIk7yhdS1pMCZM8VeNfUlSKVRhsHZNMl5O9SfaX0l0t5wjdgu4IDzGB8bpnGBBOjGST3rRFVsaaEtI4W6f7g==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-attribute": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-attribute/-/babel-plugin-remove-jsx-attribute-8.0.0.tgz", + "integrity": "sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-remove-jsx-empty-expression": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-remove-jsx-empty-expression/-/babel-plugin-remove-jsx-empty-expression-8.0.0.tgz", + "integrity": "sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-replace-jsx-attribute-value": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-replace-jsx-attribute-value/-/babel-plugin-replace-jsx-attribute-value-8.0.0.tgz", + "integrity": "sha512-KVQ+PtIjb1BuYT3ht8M5KbzWBhdAjjUPdlMtpuw/VjT8coTrItWX6Qafl9+ji831JaJcu6PJNKCV0bp01lBNzQ==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-dynamic-title": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-dynamic-title/-/babel-plugin-svg-dynamic-title-8.0.0.tgz", + "integrity": "sha512-omNiKqwjNmOQJ2v6ge4SErBbkooV2aAWwaPFs2vUY7p7GhVkzRkJ00kILXQvRhA6miHnNpXv7MRnnSjdRjK8og==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-svg-em-dimensions": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-svg-em-dimensions/-/babel-plugin-svg-em-dimensions-8.0.0.tgz", + "integrity": "sha512-mURHYnu6Iw3UBTbhGwE/vsngtCIbHE43xCRK7kCw4t01xyGqb2Pd+WXekRRoFOBIY29ZoOhUCTEweDMdrjfi9g==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-react-native-svg": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-react-native-svg/-/babel-plugin-transform-react-native-svg-8.1.0.tgz", + "integrity": "sha512-Tx8T58CHo+7nwJ+EhUwx3LfdNSG9R2OKfaIXXs5soiy5HtgoAEkDay9LIimLOcG8dJQH1wPZp/cnAv6S9CrR1Q==", + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-plugin-transform-svg-component": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-plugin-transform-svg-component/-/babel-plugin-transform-svg-component-8.0.0.tgz", + "integrity": "sha512-DFx8xa3cZXTdb/k3kfPeaixecQLgKh5NVBMwD0AQxOzcZawK4oo1Jh9LbrcACUivsCA7TLG8eeWgrDXjTMhRmw==", + "engines": { + "node": ">=12" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/babel-preset": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/babel-preset/-/babel-preset-8.1.0.tgz", + "integrity": "sha512-7EYDbHE7MxHpv4sxvnVPngw5fuR6pw79SkcrILHJ/iMpuKySNCl5W1qcwPEpU+LgyRXOaAFgH0KhwD18wwg6ug==", + "dependencies": { + "@svgr/babel-plugin-add-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-attribute": "8.0.0", + "@svgr/babel-plugin-remove-jsx-empty-expression": "8.0.0", + "@svgr/babel-plugin-replace-jsx-attribute-value": "8.0.0", + "@svgr/babel-plugin-svg-dynamic-title": "8.0.0", + "@svgr/babel-plugin-svg-em-dimensions": "8.0.0", + "@svgr/babel-plugin-transform-react-native-svg": "8.1.0", + "@svgr/babel-plugin-transform-svg-component": "8.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@svgr/core": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", + "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "camelcase": "^6.2.0", + "cosmiconfig": "^8.1.3", + "snake-case": "^3.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/hast-util-to-babel-ast": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/@svgr/hast-util-to-babel-ast/-/hast-util-to-babel-ast-8.0.0.tgz", + "integrity": "sha512-EbDKwO9GpfWP4jN9sGdYwPBU0kdomaPIL2Eu4YwmgP+sJeXT+L7bMwJUBnhzfH8Q2qMBqZ4fJwpCyYsAN3mt2Q==", + "dependencies": { + "@babel/types": "^7.21.3", + "entities": "^4.4.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@svgr/plugin-jsx": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-jsx/-/plugin-jsx-8.1.0.tgz", + "integrity": "sha512-0xiIyBsLlr8quN+WyuxooNW9RJ0Dpr8uOnH/xrCVO8GLUcwHISwj1AG0k+LFzteTkAA0GbX0kj9q6Dk70PTiPA==", + "dependencies": { + "@babel/core": "^7.21.3", + "@svgr/babel-preset": "8.1.0", + "@svgr/hast-util-to-babel-ast": "8.0.0", + "svg-parser": "^2.0.4" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/plugin-svgo": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/plugin-svgo/-/plugin-svgo-8.1.0.tgz", + "integrity": "sha512-Ywtl837OGO9pTLIN/onoWLmDQ4zFUycI1g76vuKGEz6evR/ZTJlJuz3G/fIkb6OVBJ2g0o6CGJzaEjfmEo3AHA==", + "dependencies": { + "cosmiconfig": "^8.1.3", + "deepmerge": "^4.3.1", + "svgo": "^3.0.2" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + }, + "peerDependencies": { + "@svgr/core": "*" + } + }, + "node_modules/@svgr/webpack": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@svgr/webpack/-/webpack-8.1.0.tgz", + "integrity": "sha512-LnhVjMWyMQV9ZmeEy26maJk+8HTIbd59cH4F2MJ439k9DqejRisfFNGAPvRYlKETuh9LrImlS8aKsBgKjMA8WA==", + "dependencies": { + "@babel/core": "^7.21.3", + "@babel/plugin-transform-react-constant-elements": "^7.21.3", + "@babel/preset-env": "^7.20.2", + "@babel/preset-react": "^7.18.6", + "@babel/preset-typescript": "^7.21.0", + "@svgr/core": "8.1.0", + "@svgr/plugin-jsx": "8.1.0", + "@svgr/plugin-svgo": "8.1.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/gregberge" + } + }, + "node_modules/@szmarczak/http-timer": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", + "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", + "dependencies": { + "defer-to-connect": "^2.0.1" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/@trysound/sax": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@trysound/sax/-/sax-0.2.0.tgz", + "integrity": "sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA==", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/@tsconfig/recommended": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@tsconfig/recommended/-/recommended-1.0.7.tgz", + "integrity": "sha512-xiNMgCuoy4mCL4JTywk9XFs5xpRUcKxtWEcMR6FNMtsgewYTIgIR+nvlP4A4iRCAzRsHMnPhvTRrzp4AGcRTEA==", + "dev": true + }, + "node_modules/@types/acorn": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/@types/acorn/-/acorn-4.0.6.tgz", + "integrity": "sha512-veQTnWP+1D/xbxVrPC3zHnCZRjSrKfhbMUlEA43iMZLu7EsnTtkJklIuwrCPbOi8YkvDQAiW05VQQFvvz9oieQ==", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/body-parser": { + "version": "1.19.5", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz", + "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==", + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/bonjour": { + "version": "3.5.13", + "resolved": "https://registry.npmjs.org/@types/bonjour/-/bonjour-3.5.13.tgz", + "integrity": "sha512-z9fJ5Im06zvUL548KvYNecEVlA7cVDkGUi6kZusb04mpyEFKCIZJvloCcmpmLaIahDpOQGHaHmG6imtPMmPXGQ==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.38", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", + "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect-history-api-fallback": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/@types/connect-history-api-fallback/-/connect-history-api-fallback-1.5.4.tgz", + "integrity": "sha512-n6Cr2xS1h4uAulPRdlw6Jl6s1oG8KrVilPN2yUITEs+K48EzMJJ3W1xy8K5eWuFvjp3R74AOIGSmp2UfBJ8HFw==", + "dependencies": { + "@types/express-serve-static-core": "*", + "@types/node": "*" + } + }, + "node_modules/@types/debug": { + "version": "4.1.12", + "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz", + "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", + "dependencies": { + "@types/ms": "*" + } + }, + "node_modules/@types/eslint": { + "version": "8.56.10", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.56.10.tgz", + "integrity": "sha512-Shavhk87gCtY2fhXDctcfS3e6FdxWkCx1iUZ9eEUbh7rTqlZT0/IzOkCOVt0fCjcFuZ9FPYfuezTBImfHCDBGQ==", + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint-scope": { + "version": "3.7.7", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", + "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", + "dependencies": { + "@types/eslint": "*", + "@types/estree": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", + "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==" + }, + "node_modules/@types/estree-jsx": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree-jsx/-/estree-jsx-1.0.5.tgz", + "integrity": "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg==", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/@types/express": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz", + "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.33", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.19.5", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.5.tgz", + "integrity": "sha512-y6W03tvrACO72aijJ5uF02FRq5cgDR9lUxddQ8vyF+GvmjJQqbzDcJngEjURc+ZsG31VI3hODNZJ2URj86pzmg==", + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*", + "@types/send": "*" + } + }, + "node_modules/@types/gtag.js": { + "version": "0.0.12", + "resolved": "https://registry.npmjs.org/@types/gtag.js/-/gtag.js-0.0.12.tgz", + "integrity": "sha512-YQV9bUsemkzG81Ea295/nF/5GijnD2Af7QhEofh7xu+kvCN6RdodgNwwGWXB5GMI3NoyvQo0odNctoH/qLMIpg==" + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/history": { + "version": "4.7.11", + "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.11.tgz", + "integrity": "sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==" + }, + "node_modules/@types/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==" + }, + "node_modules/@types/http-cache-semantics": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz", + "integrity": "sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==" + }, + "node_modules/@types/http-errors": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz", + "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==" + }, + "node_modules/@types/http-proxy": { + "version": "1.17.14", + "resolved": "https://registry.npmjs.org/@types/http-proxy/-/http-proxy-1.17.14.tgz", + "integrity": "sha512-SSrD0c1OQzlFX7pGu1eXxSEjemej64aaNPRhhVYUGqXh0BtldAAx37MG8btcumvpgKyZp1F5Gn3JkktdxiFv6w==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==" + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdx": { + "version": "2.0.13", + "resolved": "https://registry.npmjs.org/@types/mdx/-/mdx-2.0.13.tgz", + "integrity": "sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw==" + }, + "node_modules/@types/mime": { + "version": "1.3.5", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz", + "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==" + }, + "node_modules/@types/ms": { + "version": "0.7.34", + "resolved": "https://registry.npmjs.org/@types/ms/-/ms-0.7.34.tgz", + "integrity": "sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==" + }, + "node_modules/@types/node": { + "version": "20.14.10", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.10.tgz", + "integrity": "sha512-MdiXf+nDuMvY0gJKxyfZ7/6UFsETO7mGKF54MVD/ekJS6HdFtpZFBgrh6Pseu64XTb2MLyFPlbW6hj8HYRQNOQ==", + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "node_modules/@types/node-forge": { + "version": "1.3.11", + "resolved": "https://registry.npmjs.org/@types/node-forge/-/node-forge-1.3.11.tgz", + "integrity": "sha512-FQx220y22OKNTqaByeBGqHWYz4cl94tpcxeFdvBo3wjG6XPBuZ0BNgNZRV5J5TFmmcsJ4IzsLkmGRiQbnYsBEQ==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/parse-json": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.2.tgz", + "integrity": "sha512-dISoDXWWQwUquiKsyZ4Ng+HX2KsPL7LyHKHQwgGFEA3IaKac4Obd+h2a/a6waisAoepJlBcx9paWqjA8/HVjCw==" + }, + "node_modules/@types/prismjs": { + "version": "1.26.4", + "resolved": "https://registry.npmjs.org/@types/prismjs/-/prismjs-1.26.4.tgz", + "integrity": "sha512-rlAnzkW2sZOjbqZ743IHUhFcvzaGbqijwOu8QZnZCjfQzBqFE3s4lOTJEsxikImav9uzz/42I+O7YUs1mWgMlg==" + }, + "node_modules/@types/prop-types": { + "version": "15.7.12", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.12.tgz", + "integrity": "sha512-5zvhXYtRNRluoE/jAp4GVsSduVUzNWKkOZrCDBWYtE7biZywwdC2AcEzg+cSMLFRfVgeAFqpfNabiPjxFddV1Q==" + }, + "node_modules/@types/qs": { + "version": "6.9.15", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.15.tgz", + "integrity": "sha512-uXHQKES6DQKKCLh441Xv/dwxOq1TVS3JPUMlEqoEglvlhR6Mxnlew/Xq/LRVHpLyk7iK3zODe1qYHIMltO7XGg==" + }, + "node_modules/@types/range-parser": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz", + "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==" + }, + "node_modules/@types/react": { + "version": "18.3.3", + "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.3.tgz", + "integrity": "sha512-hti/R0pS0q1/xx+TsI73XIqk26eBsISZ2R0wUijXIngRK9R/e7Xw/cXVxQK7R5JjW+SV4zGcn5hXjudkN/pLIw==", + "dependencies": { + "@types/prop-types": "*", + "csstype": "^3.0.2" + } + }, + "node_modules/@types/react-router": { + "version": "5.1.20", + "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.20.tgz", + "integrity": "sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*" + } + }, + "node_modules/@types/react-router-config": { + "version": "5.0.11", + "resolved": "https://registry.npmjs.org/@types/react-router-config/-/react-router-config-5.0.11.tgz", + "integrity": "sha512-WmSAg7WgqW7m4x8Mt4N6ZyKz0BubSj/2tVUMsAHp+Yd2AMwcSbeFq9WympT19p5heCFmF97R9eD5uUR/t4HEqw==", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "^5.1.0" + } + }, + "node_modules/@types/react-router-dom": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.3.3.tgz", + "integrity": "sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==", + "dependencies": { + "@types/history": "^4.7.11", + "@types/react": "*", + "@types/react-router": "*" + } + }, + "node_modules/@types/retry": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", + "integrity": "sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==" + }, + "node_modules/@types/sax": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.7.tgz", + "integrity": "sha512-rO73L89PJxeYM3s3pPPjiPgVVcymqU490g0YO5n5By0k2Erzj6tay/4lr1CHAAU4JyOWd1rpQ8bCf6cZfHU96A==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/send": { + "version": "0.17.4", + "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz", + "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==", + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/serve-index": { + "version": "1.9.4", + "resolved": "https://registry.npmjs.org/@types/serve-index/-/serve-index-1.9.4.tgz", + "integrity": "sha512-qLpGZ/c2fhSs5gnYsQxtDEq3Oy8SXPClIXkW5ghvAvsNuVSA8k+gCONcUCS/UjLEYvYps+e8uBtfgXgvhwfNug==", + "dependencies": { + "@types/express": "*" + } + }, + "node_modules/@types/serve-static": { + "version": "1.15.7", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.7.tgz", + "integrity": "sha512-W8Ym+h8nhuRwaKPaDw34QUkwsGi6Rc4yYqvKFo5rm2FUEhCFbzVWrxXUxuKK8TASjWsysJY0nsmNCGhCOIsrOw==", + "dependencies": { + "@types/http-errors": "*", + "@types/node": "*", + "@types/send": "*" + } + }, + "node_modules/@types/sockjs": { + "version": "0.3.36", + "resolved": "https://registry.npmjs.org/@types/sockjs/-/sockjs-0.3.36.tgz", + "integrity": "sha512-MK9V6NzAS1+Ud7JV9lJLFqW85VbC9dq3LmwZCuBe4wBDgKC0Kj/jd8Xl+nSviU+Qc3+m7umHHyHg//2KSa0a0Q==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/unist": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.2.tgz", + "integrity": "sha512-dqId9J8K/vGi5Zr7oo212BGii5m3q5Hxlkwy3WpYuKPklmBEvsbMYYyLxAQpSffdLl/gdW0XUpKWFvYmyoWCoQ==" + }, + "node_modules/@types/ws": { + "version": "8.5.10", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.10.tgz", + "integrity": "sha512-vmQSUcfalpIq0R9q7uTo2lXs6eGIpt9wtnLdMv9LVpIjCA/+ufZRozlVoVelIYixx1ugCBKDhn89vnsEGOCx9A==", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/yargs": { + "version": "17.0.32", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.32.tgz", + "integrity": "sha512-xQ67Yc/laOG5uMfX/093MRlGGCIBzZMarVa+gfNKJxWAIgykYpVGkBdbqEzGDDfCrVUj6Hiff4mTZ5BA6TmAog==", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", + "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==" + }, + "node_modules/@webassemblyjs/ast": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.12.1.tgz", + "integrity": "sha512-EKfMUOPRRUTy5UII4qJDGPpqfwjOmZ5jeGFwid9mnoqIFK+e0vqoi1qH56JpmZSzEL53jKnNzScdmftJyG5xWg==", + "dependencies": { + "@webassemblyjs/helper-numbers": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6" + } + }, + "node_modules/@webassemblyjs/floating-point-hex-parser": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.11.6.tgz", + "integrity": "sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==" + }, + "node_modules/@webassemblyjs/helper-api-error": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.11.6.tgz", + "integrity": "sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==" + }, + "node_modules/@webassemblyjs/helper-buffer": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.12.1.tgz", + "integrity": "sha512-nzJwQw99DNDKr9BVCOZcLuJJUlqkJh+kVzVl6Fmq/tI5ZtEyWT1KZMyOXltXLZJmDtvLCDgwsyrkohEtopTXCw==" + }, + "node_modules/@webassemblyjs/helper-numbers": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.11.6.tgz", + "integrity": "sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==", + "dependencies": { + "@webassemblyjs/floating-point-hex-parser": "1.11.6", + "@webassemblyjs/helper-api-error": "1.11.6", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/helper-wasm-bytecode": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.11.6.tgz", + "integrity": "sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==" + }, + "node_modules/@webassemblyjs/helper-wasm-section": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.12.1.tgz", + "integrity": "sha512-Jif4vfB6FJlUlSbgEMHUyk1j234GTNG9dBJ4XJdOySoj518Xj0oGsNi59cUQF4RRMS9ouBUxDDdyBVfPTypa5g==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/wasm-gen": "1.12.1" + } + }, + "node_modules/@webassemblyjs/ieee754": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.11.6.tgz", + "integrity": "sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==", + "dependencies": { + "@xtuc/ieee754": "^1.2.0" + } + }, + "node_modules/@webassemblyjs/leb128": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.11.6.tgz", + "integrity": "sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==", + "dependencies": { + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/utf8": { + "version": "1.11.6", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.11.6.tgz", + "integrity": "sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==" + }, + "node_modules/@webassemblyjs/wasm-edit": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.12.1.tgz", + "integrity": "sha512-1DuwbVvADvS5mGnXbE+c9NfA8QRcZ6iKquqjjmR10k6o+zzsRVesil54DKexiowcFCPdr/Q0qaMgB01+SQ1u6g==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/helper-wasm-section": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-opt": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1", + "@webassemblyjs/wast-printer": "1.12.1" + } + }, + "node_modules/@webassemblyjs/wasm-gen": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.12.1.tgz", + "integrity": "sha512-TDq4Ojh9fcohAw6OIMXqiIcTq5KUXTGRkVxbSo1hQnSy6lAM5GSdfwWeSxpAo0YzgsgF182E/U0mDNhuA0tW7w==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wasm-opt": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.12.1.tgz", + "integrity": "sha512-Jg99j/2gG2iaz3hijw857AVYekZe2SAskcqlWIZXjji5WStnOpVoat3gQfT/Q5tb2djnCjBtMocY/Su1GfxPBg==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-buffer": "1.12.1", + "@webassemblyjs/wasm-gen": "1.12.1", + "@webassemblyjs/wasm-parser": "1.12.1" + } + }, + "node_modules/@webassemblyjs/wasm-parser": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.12.1.tgz", + "integrity": "sha512-xikIi7c2FHXysxXe3COrVUPSheuBtpcfhbpFj4gmu7KRLYOzANztwUU0IbsqvMqzuNK2+glRGWCEqZo1WCLyAQ==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@webassemblyjs/helper-api-error": "1.11.6", + "@webassemblyjs/helper-wasm-bytecode": "1.11.6", + "@webassemblyjs/ieee754": "1.11.6", + "@webassemblyjs/leb128": "1.11.6", + "@webassemblyjs/utf8": "1.11.6" + } + }, + "node_modules/@webassemblyjs/wast-printer": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.12.1.tgz", + "integrity": "sha512-+X4WAlOisVWQMikjbcvY2e0rwPsKQ9F688lksZhBcPycBBuii3O7m8FACbDMWDojpAqvjIncrG8J0XHKyQfVeA==", + "dependencies": { + "@webassemblyjs/ast": "1.12.1", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@xtuc/ieee754": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", + "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==" + }, + "node_modules/@xtuc/long": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", + "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==" + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/accepts/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/acorn": { + "version": "8.12.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.1.tgz", + "integrity": "sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-import-attributes": { + "version": "1.9.5", + "resolved": "https://registry.npmjs.org/acorn-import-attributes/-/acorn-import-attributes-1.9.5.tgz", + "integrity": "sha512-n02Vykv5uA3eHGM/Z2dQrcD56kL8TyDb2p1+0P83PClMnC/nc+anbQRhIOWnSq4Ke/KvDPrY3C9hDtC/A3eHnQ==", + "peerDependencies": { + "acorn": "^8" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", + "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/address": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/address/-/address-1.2.2.tgz", + "integrity": "sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/aggregate-error": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", + "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "dependencies": { + "clean-stack": "^2.0.0", + "indent-string": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ajv": { + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.16.0.tgz", + "integrity": "sha512-F0twR8U1ZU67JIEtekUcLkXkoO5mMMmgGD8sK/xUFzJ805jxHQl92hImFAqqXMyMYjSPOyUPAwHYhB72g5sTXw==", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.4.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-keywords": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", + "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", + "dependencies": { + "fast-deep-equal": "^3.1.3" + }, + "peerDependencies": { + "ajv": "^8.8.2" + } + }, + "node_modules/algoliasearch": { + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-4.24.0.tgz", + "integrity": "sha512-bf0QV/9jVejssFBmz2HQLxUadxk574t4iwjCKp5E7NBzwKkrDEhKPISIIjAU/p6K5qDx3qoeh4+26zWN1jmw3g==", + "dependencies": { + "@algolia/cache-browser-local-storage": "4.24.0", + "@algolia/cache-common": "4.24.0", + "@algolia/cache-in-memory": "4.24.0", + "@algolia/client-account": "4.24.0", + "@algolia/client-analytics": "4.24.0", + "@algolia/client-common": "4.24.0", + "@algolia/client-personalization": "4.24.0", + "@algolia/client-search": "4.24.0", + "@algolia/logger-common": "4.24.0", + "@algolia/logger-console": "4.24.0", + "@algolia/recommend": "4.24.0", + "@algolia/requester-browser-xhr": "4.24.0", + "@algolia/requester-common": "4.24.0", + "@algolia/requester-node-http": "4.24.0", + "@algolia/transporter": "4.24.0" + } + }, + "node_modules/algoliasearch-helper": { + "version": "3.22.2", + "resolved": "https://registry.npmjs.org/algoliasearch-helper/-/algoliasearch-helper-3.22.2.tgz", + "integrity": "sha512-3YQ6eo7uYOCHeQ2ZpD+OoT3aJJwMNKEnwtu8WMzm81XmBOSCwRjQditH9CeSOQ38qhHkuGw23pbq+kULkIJLcw==", + "dependencies": { + "@algolia/events": "^4.0.1" + }, + "peerDependencies": { + "algoliasearch": ">= 3.1 < 6" + } + }, + "node_modules/ansi-align": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "dependencies": { + "string-width": "^4.1.0" + } + }, + "node_modules/ansi-align/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + }, + "node_modules/ansi-align/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-html-community": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ansi-html-community/-/ansi-html-community-0.0.8.tgz", + "integrity": "sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==", + "engines": [ + "node >= 0.8.0" + ], + "bin": { + "ansi-html": "bin/ansi-html" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/arg": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/arg/-/arg-5.0.2.tgz", + "integrity": "sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==" + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==" + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "engines": { + "node": ">=8" + } + }, + "node_modules/astring": { + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/astring/-/astring-1.8.6.tgz", + "integrity": "sha512-ISvCdHdlTDlH5IpxQJIex7BWBywFWgjJSVdwst+/iQCoEYnyOaQ95+X1JGshuBjGp6nxKUy1jMgE3zPqN7fQdg==", + "bin": { + "astring": "bin/astring" + } + }, + "node_modules/at-least-node": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", + "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/autoprefixer": { + "version": "10.4.19", + "resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.19.tgz", + "integrity": "sha512-BaENR2+zBZ8xXhM4pUaKUxlVdxZ0EZhjvbopwnXmxRUfqDmwSpC2lAi/QXvx7NRdPCo1WKEcEF6mV64si1z4Ew==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/autoprefixer" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-lite": "^1.0.30001599", + "fraction.js": "^4.3.7", + "normalize-range": "^0.1.2", + "picocolors": "^1.0.0", + "postcss-value-parser": "^4.2.0" + }, + "bin": { + "autoprefixer": "bin/autoprefixer" + }, + "engines": { + "node": "^10 || ^12 || >=14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/babel-loader": { + "version": "9.1.3", + "resolved": "https://registry.npmjs.org/babel-loader/-/babel-loader-9.1.3.tgz", + "integrity": "sha512-xG3ST4DglodGf8qSwv0MdeWLhrDsw/32QMdTO5T1ZIp9gQur0HkCyFs7Awskr10JKXFXwpAhiCuYX5oGXnRGbw==", + "dependencies": { + "find-cache-dir": "^4.0.0", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0", + "webpack": ">=5" + } + }, + "node_modules/babel-plugin-dynamic-import-node": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.3.tgz", + "integrity": "sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==", + "dependencies": { + "object.assign": "^4.1.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.4.11", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.11.tgz", + "integrity": "sha512-sMEJ27L0gRHShOh5G54uAAPaiCOygY/5ratXuiyb2G46FmlSpc9eFCzYVyDiPxfNbwzA7mYahmjQc5q+CZQ09Q==", + "dependencies": { + "@babel/compat-data": "^7.22.6", + "@babel/helper-define-polyfill-provider": "^0.6.2", + "semver": "^6.3.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.10.4", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.10.4.tgz", + "integrity": "sha512-25J6I8NGfa5YkCDogHRID3fVCadIR8/pGl1/spvCkzb6lVn6SR3ojpx9nOn9iEBcUsjY24AmdKm5khcfKdylcg==", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.1", + "core-js-compat": "^3.36.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.2.tgz", + "integrity": "sha512-2R25rQZWP63nGwaAswvDazbPXfrM3HwVoBXK6HcqeKrSrL/JqcC/rDcf95l4r7LXLyxDXc8uQDa064GubtCABg==", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/bail": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/bail/-/bail-2.0.2.tgz", + "integrity": "sha512-0xO6mYd7JB2YesxDKplafRpsiOzPt9V02ddPCLbY1xYGPOX24NTyN50qnUxgCPcSoYMhKpAuBTjQoRZCAkUDRw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + }, + "node_modules/batch": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/batch/-/batch-0.6.1.tgz", + "integrity": "sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==" + }, + "node_modules/big.js": { + "version": "5.2.2", + "resolved": "https://registry.npmjs.org/big.js/-/big.js-5.2.2.tgz", + "integrity": "sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==", + "engines": { + "node": "*" + } + }, + "node_modules/binary-extensions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/body-parser": { + "version": "1.20.2", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.2.tgz", + "integrity": "sha512-ml9pReCu3M61kGlqoTm2umSXTlRTuGTx0bfYj+uIUKKYycG5NtSbeetV3faSU6R7ajOPw0g/J1PvK4qNy7s5bA==", + "dependencies": { + "bytes": "3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.11.0", + "raw-body": "2.5.2", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/bonjour-service": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/bonjour-service/-/bonjour-service-1.2.1.tgz", + "integrity": "sha512-oSzCS2zV14bh2kji6vNe7vrpJYCHGvcZnlffFQ1MEoX/WOeQ/teD8SYWKR942OI3INjq8OMNJlbPK5LLLUxFDw==", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "multicast-dns": "^7.2.5" + } + }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==" + }, + "node_modules/boxen": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-6.2.1.tgz", + "integrity": "sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^6.2.0", + "chalk": "^4.1.2", + "cli-boxes": "^3.0.0", + "string-width": "^5.0.1", + "type-fest": "^2.5.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.0.1" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browserslist": { + "version": "4.23.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.1.tgz", + "integrity": "sha512-TUfofFo/KsK/bWZ9TWQ5O26tsWW4Uhmt8IYklbnUa70udB6P2wA7w7o4PY4muaEPBQaAX+CEnmmIA41NVHtPVw==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "caniuse-lite": "^1.0.30001629", + "electron-to-chromium": "^1.4.796", + "node-releases": "^2.0.14", + "update-browserslist-db": "^1.0.16" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==" + }, + "node_modules/bytes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", + "integrity": "sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/cacheable-lookup": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-7.0.0.tgz", + "integrity": "sha512-+qJyx4xiKra8mZrcwhjMRMUhD5NR1R8esPkzIYxX96JiecFoxAXFuz/GpR3+ev4PE1WamHip78wV0vcmPQtp8w==", + "engines": { + "node": ">=14.16" + } + }, + "node_modules/cacheable-request": { + "version": "10.2.14", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-10.2.14.tgz", + "integrity": "sha512-zkDT5WAF4hSSoUgyfg5tFIxz8XQK+25W/TLVojJTMKBaxevLBBtLxgqguAuVQB8PVW79FVjHcU+GJ9tVbDZ9mQ==", + "dependencies": { + "@types/http-cache-semantics": "^4.0.2", + "get-stream": "^6.0.1", + "http-cache-semantics": "^4.1.1", + "keyv": "^4.5.3", + "mimic-response": "^4.0.0", + "normalize-url": "^8.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "engines": { + "node": ">=6" + } + }, + "node_modules/camel-case": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", + "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", + "dependencies": { + "pascal-case": "^3.1.2", + "tslib": "^2.0.3" + } + }, + "node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/caniuse-api": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/caniuse-api/-/caniuse-api-3.0.0.tgz", + "integrity": "sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==", + "dependencies": { + "browserslist": "^4.0.0", + "caniuse-lite": "^1.0.0", + "lodash.memoize": "^4.1.2", + "lodash.uniq": "^4.5.0" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001640", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001640.tgz", + "integrity": "sha512-lA4VMpW0PSUrFnkmVuEKBUovSWKhj7puyCg8StBChgu298N1AtuF1sKWEvfDuimSEDbhlb/KqPKC3fs1HbuQUA==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ] + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "engines": { + "node": ">=10" + } + }, + "node_modules/character-entities": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz", + "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-reference-invalid": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz", + "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/cheerio": { + "version": "1.0.0-rc.12", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.12.tgz", + "integrity": "sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==", + "dependencies": { + "cheerio-select": "^2.1.0", + "dom-serializer": "^2.0.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "htmlparser2": "^8.0.1", + "parse5": "^7.0.0", + "parse5-htmlparser2-tree-adapter": "^7.0.0" + }, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz", + "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==", + "dependencies": { + "boolbase": "^1.0.0", + "css-select": "^5.1.0", + "css-what": "^6.1.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/chokidar": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/chrome-trace-event": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", + "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", + "engines": { + "node": ">=6.0" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "engines": { + "node": ">=8" + } + }, + "node_modules/clean-css": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/clean-css/-/clean-css-5.3.3.tgz", + "integrity": "sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==", + "dependencies": { + "source-map": "~0.6.0" + }, + "engines": { + "node": ">= 10.0" + } + }, + "node_modules/clean-css/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/clean-stack": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", + "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", + "engines": { + "node": ">=6" + } + }, + "node_modules/cli-boxes": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/cli-table3": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.5.tgz", + "integrity": "sha512-+W/5efTR7y5HRD7gACw9yQjqMVvEMLBHmboM/kPWam+H+Hmyrgjh6YncVKK122YZkXrLudzTuAukUw9FnMf7IQ==", + "dependencies": { + "string-width": "^4.2.0" + }, + "engines": { + "node": "10.* || >= 12.*" + }, + "optionalDependencies": { + "@colors/colors": "1.5.0" + } + }, + "node_modules/cli-table3/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + }, + "node_modules/cli-table3/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/clsx": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", + "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "engines": { + "node": ">=6" + } + }, + "node_modules/collapse-white-space": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/collapse-white-space/-/collapse-white-space-2.1.0.tgz", + "integrity": "sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + }, + "node_modules/colord": { + "version": "2.9.3", + "resolved": "https://registry.npmjs.org/colord/-/colord-2.9.3.tgz", + "integrity": "sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==" + }, + "node_modules/colorette": { + "version": "2.0.20", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", + "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==" + }, + "node_modules/combine-promises": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/combine-promises/-/combine-promises-1.2.0.tgz", + "integrity": "sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==", + "engines": { + "node": ">=10" + } + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/commander": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", + "integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", + "engines": { + "node": ">= 6" + } + }, + "node_modules/common-path-prefix": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/common-path-prefix/-/common-path-prefix-3.0.0.tgz", + "integrity": "sha512-QE33hToZseCH3jS0qN96O/bSh3kaw/h+Tq7ngyY9eWDUnTlTNUyqfqvCXioLe5Na5jFsL78ra/wuBU4iuEgd4w==" + }, + "node_modules/compressible": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/compressible/-/compressible-2.0.18.tgz", + "integrity": "sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==", + "dependencies": { + "mime-db": ">= 1.43.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compressible/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/compression": { + "version": "1.7.4", + "resolved": "https://registry.npmjs.org/compression/-/compression-1.7.4.tgz", + "integrity": "sha512-jaSIDzP9pZVS4ZfQ+TzvtiWhdpFhE2RDHz8QJkpX9SIpLq88VueF5jJw6t+6CUQcAoA6t+x89MLrWAqpfDE8iQ==", + "dependencies": { + "accepts": "~1.3.5", + "bytes": "3.0.0", + "compressible": "~2.0.16", + "debug": "2.6.9", + "on-headers": "~1.0.2", + "safe-buffer": "5.1.2", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/compression/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/compression/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/compression/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" + }, + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", + "dependencies": { + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "node_modules/configstore": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", + "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", + "dependencies": { + "dot-prop": "^6.0.1", + "graceful-fs": "^4.2.6", + "unique-string": "^3.0.0", + "write-file-atomic": "^3.0.3", + "xdg-basedir": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/yeoman/configstore?sponsor=1" + } + }, + "node_modules/connect-history-api-fallback": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/connect-history-api-fallback/-/connect-history-api-fallback-2.0.0.tgz", + "integrity": "sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/consola": { + "version": "2.15.3", + "resolved": "https://registry.npmjs.org/consola/-/consola-2.15.3.tgz", + "integrity": "sha512-9vAdYbHj6x2fLKC4+oPH0kFzY/orMZyG2Aj+kNylHxKGJ/Ed4dpNyAQYwJOdqO4zdM7XpVHmyejQDcQHrnuXbw==" + }, + "node_modules/content-disposition": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.2.tgz", + "integrity": "sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==" + }, + "node_modules/cookie": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.6.0.tgz", + "integrity": "sha512-U71cyTamuh1CRNCfpGY6to28lxvNwPG4Guz/EVjgf3Jmzv0vlDp1atT9eS5dDjMYHucpHbWns6Lwf3BKz6svdw==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", + "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==" + }, + "node_modules/copy-text-to-clipboard": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/copy-text-to-clipboard/-/copy-text-to-clipboard-3.2.0.tgz", + "integrity": "sha512-RnJFp1XR/LOBDckxTib5Qjr/PMfkatD0MUCQgdpqS8MdKiNUzBjAQBEN6oUy+jW7LI93BBG3DtMB2KOOKpGs2Q==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/copy-webpack-plugin": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/copy-webpack-plugin/-/copy-webpack-plugin-11.0.0.tgz", + "integrity": "sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==", + "dependencies": { + "fast-glob": "^3.2.11", + "glob-parent": "^6.0.1", + "globby": "^13.1.1", + "normalize-path": "^3.0.0", + "schema-utils": "^4.0.0", + "serialize-javascript": "^6.0.0" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/copy-webpack-plugin/node_modules/globby": { + "version": "13.2.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.2.2.tgz", + "integrity": "sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==", + "dependencies": { + "dir-glob": "^3.0.1", + "fast-glob": "^3.3.0", + "ignore": "^5.2.4", + "merge2": "^1.4.1", + "slash": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/copy-webpack-plugin/node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/core-js": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.37.1.tgz", + "integrity": "sha512-Xn6qmxrQZyB0FFY8E3bgRXei3lWDJHhvI+u0q9TKIYM49G8pAr0FgnnrFRAmsbptZL1yxRADVXn+x5AGsbBfyw==", + "hasInstallScript": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-compat": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.37.1.tgz", + "integrity": "sha512-9TNiImhKvQqSUkOvk/mMRZzOANTiEVC7WaBNhHcKM7x+/5E1l5NvsysR19zuDQScE8k+kfQXWRN3AtS/eOSHpg==", + "dependencies": { + "browserslist": "^4.23.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-pure": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.37.1.tgz", + "integrity": "sha512-J/r5JTHSmzTxbiYYrzXg9w1VpqrYt+gexenBE9pugeyhwPZTAEJddyiReJWsLO6uNQ8xJZFbod6XC7KKwatCiA==", + "hasInstallScript": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==" + }, + "node_modules/cosmiconfig": { + "version": "8.3.6", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-8.3.6.tgz", + "integrity": "sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==", + "dependencies": { + "import-fresh": "^3.3.0", + "js-yaml": "^4.1.0", + "parse-json": "^5.2.0", + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/d-fischer" + }, + "peerDependencies": { + "typescript": ">=4.9.5" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/crypto-random-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "dependencies": { + "type-fest": "^1.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/crypto-random-string/node_modules/type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/css-declaration-sorter": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/css-declaration-sorter/-/css-declaration-sorter-7.2.0.tgz", + "integrity": "sha512-h70rUM+3PNFuaBDTLe8wF/cdWu+dOZmb7pJt8Z2sedYbAcQVQV/tEchueg3GWxwqS0cxtbxmaHEdkNACqcvsow==", + "engines": { + "node": "^14 || ^16 || >=18" + }, + "peerDependencies": { + "postcss": "^8.0.9" + } + }, + "node_modules/css-loader": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/css-loader/-/css-loader-6.11.0.tgz", + "integrity": "sha512-CTJ+AEQJjq5NzLga5pE39qdiSV56F8ywCIsqNIRF0r7BDgWsN25aazToqAFg7ZrtA/U016xudB3ffgweORxX7g==", + "dependencies": { + "icss-utils": "^5.1.0", + "postcss": "^8.4.33", + "postcss-modules-extract-imports": "^3.1.0", + "postcss-modules-local-by-default": "^4.0.5", + "postcss-modules-scope": "^3.2.0", + "postcss-modules-values": "^4.0.0", + "postcss-value-parser": "^4.2.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/css-minimizer-webpack-plugin": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/css-minimizer-webpack-plugin/-/css-minimizer-webpack-plugin-5.0.1.tgz", + "integrity": "sha512-3caImjKFQkS+ws1TGcFn0V1HyDJFq1Euy589JlD6/3rV2kj+w7r5G9WDMgSHvpvXHNZ2calVypZWuEDQd9wfLg==", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.18", + "cssnano": "^6.0.1", + "jest-worker": "^29.4.3", + "postcss": "^8.4.24", + "schema-utils": "^4.0.1", + "serialize-javascript": "^6.0.1" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + }, + "peerDependenciesMeta": { + "@parcel/css": { + "optional": true + }, + "@swc/css": { + "optional": true + }, + "clean-css": { + "optional": true + }, + "csso": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "lightningcss": { + "optional": true + } + } + }, + "node_modules/css-select": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.1.0.tgz", + "integrity": "sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.1.0", + "domhandler": "^5.0.2", + "domutils": "^3.0.1", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-tree": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz", + "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==", + "dependencies": { + "mdn-data": "2.0.30", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0" + } + }, + "node_modules/css-what": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz", + "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==", + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/cssesc": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz", + "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==", + "bin": { + "cssesc": "bin/cssesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/cssnano": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano/-/cssnano-6.1.2.tgz", + "integrity": "sha512-rYk5UeX7VAM/u0lNqewCdasdtPK81CgX8wJFLEIXHbV2oldWRgJAsZrdhRXkV1NJzA2g850KiFm9mMU2HxNxMA==", + "dependencies": { + "cssnano-preset-default": "^6.1.2", + "lilconfig": "^3.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/cssnano" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-advanced": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-advanced/-/cssnano-preset-advanced-6.1.2.tgz", + "integrity": "sha512-Nhao7eD8ph2DoHolEzQs5CfRpiEP0xa1HBdnFZ82kvqdmbwVBUr2r1QuQ4t1pi+D1ZpqpcO4T+wy/7RxzJ/WPQ==", + "dependencies": { + "autoprefixer": "^10.4.19", + "browserslist": "^4.23.0", + "cssnano-preset-default": "^6.1.2", + "postcss-discard-unused": "^6.0.5", + "postcss-merge-idents": "^6.0.3", + "postcss-reduce-idents": "^6.0.3", + "postcss-zindex": "^6.0.2" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-preset-default": { + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/cssnano-preset-default/-/cssnano-preset-default-6.1.2.tgz", + "integrity": "sha512-1C0C+eNaeN8OcHQa193aRgYexyJtU8XwbdieEjClw+J9d94E41LwT6ivKH0WT+fYwYWB0Zp3I3IZ7tI/BbUbrg==", + "dependencies": { + "browserslist": "^4.23.0", + "css-declaration-sorter": "^7.2.0", + "cssnano-utils": "^4.0.2", + "postcss-calc": "^9.0.1", + "postcss-colormin": "^6.1.0", + "postcss-convert-values": "^6.1.0", + "postcss-discard-comments": "^6.0.2", + "postcss-discard-duplicates": "^6.0.3", + "postcss-discard-empty": "^6.0.3", + "postcss-discard-overridden": "^6.0.2", + "postcss-merge-longhand": "^6.0.5", + "postcss-merge-rules": "^6.1.1", + "postcss-minify-font-values": "^6.1.0", + "postcss-minify-gradients": "^6.0.3", + "postcss-minify-params": "^6.1.0", + "postcss-minify-selectors": "^6.0.4", + "postcss-normalize-charset": "^6.0.2", + "postcss-normalize-display-values": "^6.0.2", + "postcss-normalize-positions": "^6.0.2", + "postcss-normalize-repeat-style": "^6.0.2", + "postcss-normalize-string": "^6.0.2", + "postcss-normalize-timing-functions": "^6.0.2", + "postcss-normalize-unicode": "^6.1.0", + "postcss-normalize-url": "^6.0.2", + "postcss-normalize-whitespace": "^6.0.2", + "postcss-ordered-values": "^6.0.2", + "postcss-reduce-initial": "^6.1.0", + "postcss-reduce-transforms": "^6.0.2", + "postcss-svgo": "^6.0.3", + "postcss-unique-selectors": "^6.0.4" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/cssnano-utils": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/cssnano-utils/-/cssnano-utils-4.0.2.tgz", + "integrity": "sha512-ZR1jHg+wZ8o4c3zqf1SIUSTIvm/9mU343FMR6Obe/unskbvpGhZOo1J6d/r8D1pzkRQYuwbcH3hToOuoA2G7oQ==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/csso": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/csso/-/csso-5.0.5.tgz", + "integrity": "sha512-0LrrStPOdJj+SPCCrGhzryycLjwcgUSHBtxNA8aIDxf0GLsRh1cKYhB00Gd1lDOS4yGH69+SNn13+TWbVHETFQ==", + "dependencies": { + "css-tree": "~2.2.0" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/css-tree": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.2.1.tgz", + "integrity": "sha512-OA0mILzGc1kCOCSJerOeqDxDQ4HOh+G8NbOJFOTgOCzpw7fCBubk0fEyxp8AgOL/jvLgYA/uV0cMbe43ElF1JA==", + "dependencies": { + "mdn-data": "2.0.28", + "source-map-js": "^1.0.1" + }, + "engines": { + "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0", + "npm": ">=7.0.0" + } + }, + "node_modules/csso/node_modules/mdn-data": { + "version": "2.0.28", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.28.tgz", + "integrity": "sha512-aylIc7Z9y4yzHYAJNuESG3hfhC+0Ibp/MAMiaOZgNv4pmEdFyfZhhhny4MNiAfWdBQ1RQ2mfDWmM1x8SvGyp8g==" + }, + "node_modules/csstype": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", + "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + }, + "node_modules/debounce": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/debounce/-/debounce-1.2.1.tgz", + "integrity": "sha512-XRRe6Glud4rd/ZGQfiV1ruXSfbvfJedlV9Y6zOlP+2K04vBYiJEte6stfFkCP03aMnY5tsipamumUjL14fofug==" + }, + "node_modules/debug": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", + "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decode-named-character-reference": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.0.2.tgz", + "integrity": "sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg==", + "dependencies": { + "character-entities": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/decompress-response/node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/default-gateway": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/default-gateway/-/default-gateway-6.0.3.tgz", + "integrity": "sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg==", + "dependencies": { + "execa": "^5.0.0" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/defer-to-connect": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", + "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", + "engines": { + "node": ">=10" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-lazy-prop": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", + "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==", + "engines": { + "node": ">=8" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/del": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/del/-/del-6.1.1.tgz", + "integrity": "sha512-ua8BhapfP0JUJKC/zV9yHHDW/rDoDxP4Zhn3AkA6/xT6gY7jYXJiaeyBZznYVujhZZET+UgcbZiQ7sN3WqcImg==", + "dependencies": { + "globby": "^11.0.1", + "graceful-fs": "^4.2.4", + "is-glob": "^4.0.1", + "is-path-cwd": "^2.2.0", + "is-path-inside": "^3.0.2", + "p-map": "^4.0.0", + "rimraf": "^3.0.2", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "engines": { + "node": ">=6" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/detect-node": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.1.0.tgz", + "integrity": "sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==" + }, + "node_modules/detect-port": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/detect-port/-/detect-port-1.6.1.tgz", + "integrity": "sha512-CmnVc+Hek2egPx1PeTFVta2W78xy2K/9Rkf6cC4T59S50tVnzKj+tnx5mmx5lwvCkujZ4uRrpRSuV+IVs3f90Q==", + "dependencies": { + "address": "^1.0.1", + "debug": "4" + }, + "bin": { + "detect": "bin/detect-port.js", + "detect-port": "bin/detect-port.js" + }, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/detect-port-alt": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/detect-port-alt/-/detect-port-alt-1.1.6.tgz", + "integrity": "sha512-5tQykt+LqfJFBEYaDITx7S7cR7mJ/zQmLXZ2qt5w04ainYZw6tBf9dBunMjVeVOdYVRUzUOE4HkY5J7+uttb5Q==", + "dependencies": { + "address": "^1.0.1", + "debug": "^2.6.0" + }, + "bin": { + "detect": "bin/detect-port", + "detect-port": "bin/detect-port" + }, + "engines": { + "node": ">= 4.2.1" + } + }, + "node_modules/detect-port-alt/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/detect-port-alt/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/dns-packet": { + "version": "5.6.1", + "resolved": "https://registry.npmjs.org/dns-packet/-/dns-packet-5.6.1.tgz", + "integrity": "sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==", + "dependencies": { + "@leichtgewicht/ip-codec": "^2.0.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/docusaurus-plugin-typedoc": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.0.4.tgz", + "integrity": "sha512-7ThkCm4byCfOAyhuyIJiBmU7g9MB9KavamYJJBe5s8NYuqLnXh1YOTPri5FsCTF3dDCRx108zR161tPW9MptsQ==", + "dev": true, + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.0.0" + } + }, + "node_modules/docusaurus-theme-github-codeblock": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/docusaurus-theme-github-codeblock/-/docusaurus-theme-github-codeblock-2.0.2.tgz", + "integrity": "sha512-H2WoQPWOLjGZO6KS58Gsd+eUVjTFJemkReiSSu9chqokyLc/3Ih3+zPRYfuEZ/HsDvSMIarf7CNcp+Vt+/G+ig==", + "dependencies": { + "@docusaurus/types": "^3.0.0" + } + }, + "node_modules/dom-converter": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", + "integrity": "sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==", + "dependencies": { + "utila": "~0.4" + } + }, + "node_modules/dom-serializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", + "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==", + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.2", + "entities": "^4.2.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ] + }, + "node_modules/domhandler": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz", + "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==", + "dependencies": { + "domelementtype": "^2.3.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.1.0.tgz", + "integrity": "sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==", + "dependencies": { + "dom-serializer": "^2.0.0", + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/dot-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", + "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/dot-prop": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", + "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", + "dependencies": { + "is-obj": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/dot-prop/node_modules/is-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", + "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "engines": { + "node": ">=8" + } + }, + "node_modules/duplexer": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", + "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==" + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==" + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==" + }, + "node_modules/electron-to-chromium": { + "version": "1.4.819", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.819.tgz", + "integrity": "sha512-8RwI6gKUokbHWcN3iRij/qpvf/wCbIVY5slODi85werwqUQwpFXM+dvUBND93Qh7SB0pW3Hlq3/wZsqQ3M9Jaw==" + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==" + }, + "node_modules/emojilib": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/emojilib/-/emojilib-2.4.0.tgz", + "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==" + }, + "node_modules/emojis-list": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", + "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", + "engines": { + "node": ">= 4" + } + }, + "node_modules/emoticon": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/emoticon/-/emoticon-4.0.1.tgz", + "integrity": "sha512-dqx7eA9YaqyvYtUhJwT4rC1HIp82j5ybS1/vQ42ur+jBe17dJMwZE4+gvL1XadSFfxaPFFGt3Xsw+Y8akThDlw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/enhanced-resolve": { + "version": "5.17.0", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.17.0.tgz", + "integrity": "sha512-dwDPwZL0dmye8Txp2gzFmA6sxALaSvdRDjPH0viLcKrtlOL3tw62nWWweVD1SdILDTJrbrL6tdWVN58Wo6U3eA==", + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.2.0" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-module-lexer": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.5.4.tgz", + "integrity": "sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw==" + }, + "node_modules/escalade": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz", + "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-goat": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==" + }, + "node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estree-util-attach-comments": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-attach-comments/-/estree-util-attach-comments-3.0.0.tgz", + "integrity": "sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-build-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/estree-util-build-jsx/-/estree-util-build-jsx-3.0.1.tgz", + "integrity": "sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "estree-walker": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-is-identifier-name": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/estree-util-is-identifier-name/-/estree-util-is-identifier-name-3.0.0.tgz", + "integrity": "sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-to-js": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-to-js/-/estree-util-to-js-2.0.0.tgz", + "integrity": "sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "astring": "^1.8.0", + "source-map": "^0.7.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-util-value-to-estree": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.1.2.tgz", + "integrity": "sha512-S0gW2+XZkmsx00tU2uJ4L9hUT7IFabbml9pHh2WQqFmAbxit++YGZne0sKJbNwkj9Wvg9E4uqWl4nCIFQMmfag==", + "dependencies": { + "@types/estree": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/remcohaszing" + } + }, + "node_modules/estree-util-visit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/estree-util-visit/-/estree-util-visit-2.0.0.tgz", + "integrity": "sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/eta": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/eta/-/eta-2.2.0.tgz", + "integrity": "sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==", + "engines": { + "node": ">=6.0.0" + }, + "funding": { + "url": "https://github.com/eta-dev/eta?sponsor=1" + } + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/eval": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/eval/-/eval-0.1.8.tgz", + "integrity": "sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==", + "dependencies": { + "@types/node": "*", + "require-like": ">= 0.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/eventemitter3": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", + "integrity": "sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==" + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/express": { + "version": "4.19.2", + "resolved": "https://registry.npmjs.org/express/-/express-4.19.2.tgz", + "integrity": "sha512-5T6nhjsT+EOMzuck8JjBHARTHfMht0POzlA60WV2pMD3gyXw2LZnZ+ueGdNxG+0calOJcWKbpFcuzLZ91YWq9Q==", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.2", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.6.0", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.2.0", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.1", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.7", + "proxy-addr": "~2.0.7", + "qs": "6.11.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.18.0", + "serve-static": "1.15.0", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + } + }, + "node_modules/express/node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/express/node_modules/path-to-regexp": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", + "integrity": "sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==" + }, + "node_modules/express/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" + }, + "node_modules/extend-shallow": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", + "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==", + "dependencies": { + "is-extendable": "^0.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + }, + "node_modules/fast-glob": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", + "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + }, + "node_modules/fast-url-parser": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/fast-url-parser/-/fast-url-parser-1.1.3.tgz", + "integrity": "sha512-5jOCVXADYNuRkKFzNJ0dCCewsZiYo0dz8QNYljkOpFC6r2U4OBmKtvm/Tsuh4w1YYdDqDb31a8TVhBJ2OJKdqQ==", + "dependencies": { + "punycode": "^1.3.2" + } + }, + "node_modules/fastq": { + "version": "1.17.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", + "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fault": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fault/-/fault-2.0.1.tgz", + "integrity": "sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==", + "dependencies": { + "format": "^0.2.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/faye-websocket": { + "version": "0.11.4", + "resolved": "https://registry.npmjs.org/faye-websocket/-/faye-websocket-0.11.4.tgz", + "integrity": "sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==", + "dependencies": { + "websocket-driver": ">=0.5.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/feed": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/feed/-/feed-4.2.2.tgz", + "integrity": "sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==", + "dependencies": { + "xml-js": "^1.6.11" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/file-loader": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/file-loader/-/file-loader-6.2.0.tgz", + "integrity": "sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==", + "dependencies": { + "loader-utils": "^2.0.0", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/file-loader/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/file-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/file-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/file-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/filesize": { + "version": "8.0.7", + "resolved": "https://registry.npmjs.org/filesize/-/filesize-8.0.7.tgz", + "integrity": "sha512-pjmC+bkIF8XI7fWaH8KxHcZL3DPybs1roSKP4rKDvy20tAWwIObE4+JIseG2byfGKhud5ZnM4YSGKBz7Sh0ndQ==", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/finalhandler": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.2.0.tgz", + "integrity": "sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg==", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/find-cache-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-4.0.0.tgz", + "integrity": "sha512-9ZonPT4ZAK4a+1pUPVPZJapbi7O5qbbJPdYw/NOQWZZbVLdDTYM3A4R9z/DpAM08IDaFGsvPgiGZ82WEwUDWjg==", + "dependencies": { + "common-path-prefix": "^3.0.0", + "pkg-dir": "^7.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/find-up": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-6.3.0.tgz", + "integrity": "sha512-v2ZsoEuVHYy8ZIlYqwPe/39Cy+cFDzp4dXPaxNvkEuouymu+2Jbz0PxpKarJHYJTmv2HWT3O382qY8l4jMWthw==", + "dependencies": { + "locate-path": "^7.1.0", + "path-exists": "^5.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/flat": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", + "integrity": "sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==", + "bin": { + "flat": "cli.js" + } + }, + "node_modules/follow-redirects": { + "version": "1.15.6", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz", + "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, + "node_modules/fork-ts-checker-webpack-plugin": { + "version": "6.5.3", + "resolved": "https://registry.npmjs.org/fork-ts-checker-webpack-plugin/-/fork-ts-checker-webpack-plugin-6.5.3.tgz", + "integrity": "sha512-SbH/l9ikmMWycd5puHJKTkZJKddF4iRLyW3DeZ08HTI7NGyLS38MXd/KGgeWumQO7YNQbW2u/NtPT2YowbPaGQ==", + "dependencies": { + "@babel/code-frame": "^7.8.3", + "@types/json-schema": "^7.0.5", + "chalk": "^4.1.0", + "chokidar": "^3.4.2", + "cosmiconfig": "^6.0.0", + "deepmerge": "^4.2.2", + "fs-extra": "^9.0.0", + "glob": "^7.1.6", + "memfs": "^3.1.2", + "minimatch": "^3.0.4", + "schema-utils": "2.7.0", + "semver": "^7.3.2", + "tapable": "^1.0.0" + }, + "engines": { + "node": ">=10", + "yarn": ">=1.0.0" + }, + "peerDependencies": { + "eslint": ">= 6", + "typescript": ">= 2.7", + "vue-template-compiler": "*", + "webpack": ">= 4" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + }, + "vue-template-compiler": { + "optional": true + } + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/cosmiconfig": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-6.0.0.tgz", + "integrity": "sha512-xb3ZL6+L8b9JLLCx3ZdoZy4+2ECphCMo2PwqgP1tlfVq6M6YReyzBJtvWWtbDSpNr9hn96pkCiZqUcFEc+54Qg==", + "dependencies": { + "@types/parse-json": "^4.0.0", + "import-fresh": "^3.1.0", + "parse-json": "^5.0.0", + "path-type": "^4.0.0", + "yaml": "^1.7.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dependencies": { + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/schema-utils": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-2.7.0.tgz", + "integrity": "sha512-0ilKFI6QQF5nxDZLFn2dMjvc4hjg/Wkg7rHd3jK6/A4a1Hl9VFdQWvgB1UMGoU94pad1P/8N7fMcEnLnSiju8A==", + "dependencies": { + "@types/json-schema": "^7.0.4", + "ajv": "^6.12.2", + "ajv-keywords": "^3.4.1" + }, + "engines": { + "node": ">= 8.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/fork-ts-checker-webpack-plugin/node_modules/tapable": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-1.1.3.tgz", + "integrity": "sha512-4WK/bYZmj8xLr+HUCODHGF1ZFzsYffasLUgEiMBY4fgtltdO6B4WJtlSbPaDTLpYTcGVwM2qLnFTICEcNxs3kA==", + "engines": { + "node": ">=6" + } + }, + "node_modules/form-data-encoder": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-2.1.4.tgz", + "integrity": "sha512-yDYSgNMraqvnxiEXO4hi88+YZxaHC6QKzb5N84iRCTDeRO7ZALpir/lVmf/uXUhnwUr2O4HU8s/n6x+yNjQkHw==", + "engines": { + "node": ">= 14.17" + } + }, + "node_modules/format": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/format/-/format-0.2.2.tgz", + "integrity": "sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==", + "engines": { + "node": ">=0.4.x" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fraction.js": { + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/fraction.js/-/fraction.js-4.3.7.tgz", + "integrity": "sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew==", + "engines": { + "node": "*" + }, + "funding": { + "type": "patreon", + "url": "https://github.com/sponsors/rawify" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "11.2.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.2.0.tgz", + "integrity": "sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, + "node_modules/fs-monkey": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.6.tgz", + "integrity": "sha512-b1FMfwetIKymC0eioW7mTywihSQE4oLzQn1dB6rZB5fx/3NpNEdAWeCSMB+60/AeT0TCXsxzAlcYVEFCTAksWg==" + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-intrinsic": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-own-enumerable-property-symbols": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", + "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==" + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/github-slugger": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/github-slugger/-/github-slugger-1.5.0.tgz", + "integrity": "sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==" + }, + "node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/glob-to-regexp": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", + "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==" + }, + "node_modules/global-dirs": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.1.tgz", + "integrity": "sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==", + "dependencies": { + "ini": "2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/global-dirs/node_modules/ini": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", + "engines": { + "node": ">=10" + } + }, + "node_modules/global-modules": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/global-modules/-/global-modules-2.0.0.tgz", + "integrity": "sha512-NGbfmJBp9x8IxyJSd1P+otYK8vonoJactOogrVfFRIAEY1ukil8RSKDz2Yo7wh1oihl51l/r6W4epkeKJHqL8A==", + "dependencies": { + "global-prefix": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/global-prefix": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/global-prefix/-/global-prefix-3.0.0.tgz", + "integrity": "sha512-awConJSVCHVGND6x3tmMaKcQvwXLhjdkmomy2W+Goaui8YPgYgXJZewhg3fWC+DlfqqQuWg8AwqjGTD2nAPVWg==", + "dependencies": { + "ini": "^1.3.5", + "kind-of": "^6.0.2", + "which": "^1.3.1" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/global-prefix/node_modules/which": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", + "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/globals": { + "version": "11.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", + "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", + "engines": { + "node": ">=4" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/got": { + "version": "12.6.1", + "resolved": "https://registry.npmjs.org/got/-/got-12.6.1.tgz", + "integrity": "sha512-mThBblvlAF1d4O5oqyvN+ZxLAYwIJK7bpMxgYqPD9okW0C3qm5FFn7k811QrcuEBwaogR3ngOFoCfs6mRv7teQ==", + "dependencies": { + "@sindresorhus/is": "^5.2.0", + "@szmarczak/http-timer": "^5.0.1", + "cacheable-lookup": "^7.0.0", + "cacheable-request": "^10.2.8", + "decompress-response": "^6.0.0", + "form-data-encoder": "^2.1.2", + "get-stream": "^6.0.1", + "http2-wrapper": "^2.1.10", + "lowercase-keys": "^3.0.0", + "p-cancelable": "^3.0.0", + "responselike": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/got?sponsor=1" + } + }, + "node_modules/got/node_modules/@sindresorhus/is": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-5.6.0.tgz", + "integrity": "sha512-TV7t8GKYaJWsn00tFDqBw8+Uqmr8A0fRU1tvTQhyZzGv0sJCGRQL3JGMI3ucuKo3XIZdUP+Lx7/gh2t3lewy7g==", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sindresorhus/is?sponsor=1" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==" + }, + "node_modules/gray-matter": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/gray-matter/-/gray-matter-4.0.3.tgz", + "integrity": "sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==", + "dependencies": { + "js-yaml": "^3.13.1", + "kind-of": "^6.0.2", + "section-matter": "^1.0.0", + "strip-bom-string": "^1.0.0" + }, + "engines": { + "node": ">=6.0" + } + }, + "node_modules/gray-matter/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/gray-matter/node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/gzip-size": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/gzip-size/-/gzip-size-6.0.0.tgz", + "integrity": "sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==", + "dependencies": { + "duplexer": "^0.1.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/handle-thing": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/handle-thing/-/handle-thing-2.0.1.tgz", + "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==" + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-yarn": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", + "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/hast-util-from-parse5": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/hast-util-from-parse5/-/hast-util-from-parse5-8.0.1.tgz", + "integrity": "sha512-Er/Iixbc7IEa7r/XLtuG52zoqn/b3Xng/w6aZQ0xGVxzhw5xUFxcRqdPzP6yFi/4HBYRaifaI5fQ1RH8n0ZeOQ==", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "hastscript": "^8.0.0", + "property-information": "^6.0.0", + "vfile": "^6.0.0", + "vfile-location": "^5.0.0", + "web-namespaces": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-parse-selector": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz", + "integrity": "sha512-wkQCkSYoOGCRKERFWcxMVMOcYE2K1AaNLU8DXS9arxnLOUEWbOXKXiJUNzEpqZ3JOKpnha3jkFrumEjVliDe7A==", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-raw": { + "version": "9.0.4", + "resolved": "https://registry.npmjs.org/hast-util-raw/-/hast-util-raw-9.0.4.tgz", + "integrity": "sha512-LHE65TD2YiNsHD3YuXcKPHXPLuYh/gjp12mOfU8jxSrm1f/yJpsb0F/KKljS6U9LJoP0Ux+tCe8iJ2AsPzTdgA==", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "@ungap/structured-clone": "^1.0.0", + "hast-util-from-parse5": "^8.0.0", + "hast-util-to-parse5": "^8.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "parse5": "^7.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-estree": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/hast-util-to-estree/-/hast-util-to-estree-3.1.0.tgz", + "integrity": "sha512-lfX5g6hqVh9kjS/B9E2gSkvHH4SZNiQFiqWS0x9fENzEl+8W12RqdRxX6d/Cwxi30tPQs3bIO+aolQJNp1bIyw==", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-attach-comments": "^3.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-object": "^0.4.0", + "unist-util-position": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.0.tgz", + "integrity": "sha512-H/y0+IWPdsLLS738P8tDnrQ8Z+dj12zQQ6WC11TIM21C8WFVoIxcqWXf2H3hiTVZjF1AWqoimGwrTWecWrnmRQ==", + "dependencies": { + "@types/estree": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "hast-util-whitespace": "^3.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0", + "style-to-object": "^1.0.0", + "unist-util-position": "^5.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-to-jsx-runtime/node_modules/inline-style-parser": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.2.3.tgz", + "integrity": "sha512-qlD8YNDqyTKTyuITrDOffsl6Tdhv+UC4hcdAVuQsK4IMQ99nSgd1MIA/Q+jQYoh9r3hVUXhYh7urSRmXPkW04g==" + }, + "node_modules/hast-util-to-jsx-runtime/node_modules/style-to-object": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-1.0.6.tgz", + "integrity": "sha512-khxq+Qm3xEyZfKd/y9L3oIWQimxuc4STrQKtQn8aSDRHb8mFgpukgX1hdzfrMEW6JCjyJ8p89x+IUMVnCBI1PA==", + "dependencies": { + "inline-style-parser": "0.2.3" + } + }, + "node_modules/hast-util-to-parse5": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/hast-util-to-parse5/-/hast-util-to-parse5-8.0.0.tgz", + "integrity": "sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw==", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "devlop": "^1.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0", + "web-namespaces": "^2.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hastscript": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-8.0.0.tgz", + "integrity": "sha512-dMOtzCEd3ABUeSIISmrETiKuyydk1w0pa+gE/uormcTpSYuaNJPbX1NU3JLyscSLjwAQM8bWMhhIlnCqnRvDTw==", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", + "bin": { + "he": "bin/he" + } + }, + "node_modules/history": { + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", + "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", + "dependencies": { + "@babel/runtime": "^7.1.2", + "loose-envify": "^1.2.0", + "resolve-pathname": "^3.0.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0", + "value-equal": "^1.0.1" + } + }, + "node_modules/hoist-non-react-statics": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", + "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", + "dependencies": { + "react-is": "^16.7.0" + } + }, + "node_modules/hpack.js": { + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/hpack.js/-/hpack.js-2.1.6.tgz", + "integrity": "sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==", + "dependencies": { + "inherits": "^2.0.1", + "obuf": "^1.0.0", + "readable-stream": "^2.0.1", + "wbuf": "^1.1.0" + } + }, + "node_modules/hpack.js/node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==" + }, + "node_modules/hpack.js/node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/hpack.js/node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" + }, + "node_modules/hpack.js/node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, + "node_modules/html-entities": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/html-entities/-/html-entities-2.5.2.tgz", + "integrity": "sha512-K//PSRMQk4FZ78Kyau+mZurHn3FH0Vwr+H36eE0rPbeYkRRi9YxceYPhuN60UwWorxyKHhqoAJl2OFKa4BVtaA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/mdevils" + }, + { + "type": "patreon", + "url": "https://patreon.com/mdevils" + } + ] + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==" + }, + "node_modules/html-minifier-terser": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-7.2.0.tgz", + "integrity": "sha512-tXgn3QfqPIpGl9o+K5tpcj3/MN4SfLtsx2GWwBC3SSd0tXQGyF3gsSqad8loJgKZGM3ZxbYDd5yhiBIdWpmvLA==", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "~5.3.2", + "commander": "^10.0.0", + "entities": "^4.4.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.15.1" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": "^14.13.1 || >=16.0.0" + } + }, + "node_modules/html-minifier-terser/node_modules/commander": { + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", + "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", + "engines": { + "node": ">=14" + } + }, + "node_modules/html-tags": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/html-tags/-/html-tags-3.3.1.tgz", + "integrity": "sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/html-webpack-plugin": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/html-webpack-plugin/-/html-webpack-plugin-5.6.0.tgz", + "integrity": "sha512-iwaY4wzbe48AfKLZ/Cc8k0L+FKG6oSNRaZ8x5A/T/IVDGyXcbHncM9TdDa93wn0FsSm82FhTKW7f3vS61thXAw==", + "dependencies": { + "@types/html-minifier-terser": "^6.0.0", + "html-minifier-terser": "^6.0.2", + "lodash": "^4.17.21", + "pretty-error": "^4.0.0", + "tapable": "^2.0.0" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/html-webpack-plugin" + }, + "peerDependencies": { + "@rspack/core": "0.x || 1.x", + "webpack": "^5.20.0" + }, + "peerDependenciesMeta": { + "@rspack/core": { + "optional": true + }, + "webpack": { + "optional": true + } + } + }, + "node_modules/html-webpack-plugin/node_modules/commander": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", + "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==", + "engines": { + "node": ">= 12" + } + }, + "node_modules/html-webpack-plugin/node_modules/html-minifier-terser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz", + "integrity": "sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==", + "dependencies": { + "camel-case": "^4.1.2", + "clean-css": "^5.2.2", + "commander": "^8.3.0", + "he": "^1.2.0", + "param-case": "^3.0.4", + "relateurl": "^0.2.7", + "terser": "^5.10.0" + }, + "bin": { + "html-minifier-terser": "cli.js" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/htmlparser2": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-8.0.2.tgz", + "integrity": "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "dependencies": { + "domelementtype": "^2.3.0", + "domhandler": "^5.0.3", + "domutils": "^3.0.1", + "entities": "^4.4.0" + } + }, + "node_modules/http-cache-semantics": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", + "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==" + }, + "node_modules/http-deceiver": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/http-deceiver/-/http-deceiver-1.2.7.tgz", + "integrity": "sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==" + }, + "node_modules/http-errors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", + "integrity": "sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==", + "dependencies": { + "depd": "2.0.0", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/http-parser-js": { + "version": "0.5.8", + "resolved": "https://registry.npmjs.org/http-parser-js/-/http-parser-js-0.5.8.tgz", + "integrity": "sha512-SGeBX54F94Wgu5RH3X5jsDtf4eHyRogWX1XGT3b4HuW3tQPM4AaBzoUji/4AAJNXCEOWZ5O0DgZmJw1947gD5Q==" + }, + "node_modules/http-proxy": { + "version": "1.18.1", + "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.18.1.tgz", + "integrity": "sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==", + "dependencies": { + "eventemitter3": "^4.0.0", + "follow-redirects": "^1.0.0", + "requires-port": "^1.0.0" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/http-proxy-middleware": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.6.tgz", + "integrity": "sha512-ya/UeJ6HVBYxrgYotAZo1KvPWlgB48kUJLDePFeneHsVujFaW5WNj2NgWCAE//B1Dl02BIfYlpNgBy8Kf8Rjmw==", + "dependencies": { + "@types/http-proxy": "^1.17.8", + "http-proxy": "^1.18.1", + "is-glob": "^4.0.1", + "is-plain-obj": "^3.0.0", + "micromatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "@types/express": "^4.17.13" + }, + "peerDependenciesMeta": { + "@types/express": { + "optional": true + } + } + }, + "node_modules/http-proxy-middleware/node_modules/is-plain-obj": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-3.0.0.tgz", + "integrity": "sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/http2-wrapper": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.2.1.tgz", + "integrity": "sha512-V5nVw1PAOgfI3Lmeaj2Exmeg7fenjhRUgz1lPSezy1CuhPYbgQtbQj4jZfEAEMlaL+vupsvhjqCyjzob0yxsmQ==", + "dependencies": { + "quick-lru": "^5.1.1", + "resolve-alpn": "^1.2.0" + }, + "engines": { + "node": ">=10.19.0" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/icss-utils": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/icss-utils/-/icss-utils-5.1.0.tgz", + "integrity": "sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/ignore": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", + "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "engines": { + "node": ">= 4" + } + }, + "node_modules/image-size": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.1.1.tgz", + "integrity": "sha512-541xKlUw6jr/6gGuk92F+mYM5zaFAc5ahphvkqvNe2bQ6gVBkd6bfrmVJ2t4KDAfikAYZyIqTnktX3i6/aQDrQ==", + "dependencies": { + "queue": "6.0.2" + }, + "bin": { + "image-size": "bin/image-size.js" + }, + "engines": { + "node": ">=16.x" + } + }, + "node_modules/immer": { + "version": "9.0.21", + "resolved": "https://registry.npmjs.org/immer/-/immer-9.0.21.tgz", + "integrity": "sha512-bc4NBHqOqSfRW7POMkHd51LvClaeMXpm8dx0e8oE2GORbq5aRK7Bxl4FyzVLdGtLmvLKL7BTDBG5ACQm4HWjTA==", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/immer" + } + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "engines": { + "node": ">=8" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "engines": { + "node": ">=8" + } + }, + "node_modules/infima": { + "version": "0.2.0-alpha.43", + "resolved": "https://registry.npmjs.org/infima/-/infima-0.2.0-alpha.43.tgz", + "integrity": "sha512-2uw57LvUqW0rK/SWYnd/2rRfxNA5DDNOh33jxF7fy46VWoNhGxiUQyVZHbBMjQ33mQem0cjdDVwgWVAmlRfgyQ==", + "engines": { + "node": ">=12" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + }, + "node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==" + }, + "node_modules/inline-style-parser": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/inline-style-parser/-/inline-style-parser-0.1.1.tgz", + "integrity": "sha512-7NXolsK4CAS5+xvdj5OMMbI962hU/wvwoxk+LWR9Ek9bVtyuuYScDN6eS0rUm6TxApFpw7CX1o4uJzcd4AyD3Q==" + }, + "node_modules/interpret": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", + "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/invariant": { + "version": "2.2.4", + "resolved": "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz", + "integrity": "sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==", + "dependencies": { + "loose-envify": "^1.0.0" + } + }, + "node_modules/ipaddr.js": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-2.2.0.tgz", + "integrity": "sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA==", + "engines": { + "node": ">= 10" + } + }, + "node_modules/is-alphabetical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz", + "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-alphanumerical": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz", + "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==", + "dependencies": { + "is-alphabetical": "^2.0.0", + "is-decimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==" + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-ci": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", + "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", + "dependencies": { + "ci-info": "^3.2.0" + }, + "bin": { + "is-ci": "bin.js" + } + }, + "node_modules/is-core-module": { + "version": "2.14.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz", + "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-decimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz", + "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-docker": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz", + "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-extendable": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", + "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-hexadecimal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz", + "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/is-installed-globally": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", + "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", + "dependencies": { + "global-dirs": "^3.0.0", + "is-path-inside": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-npm": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.0.0.tgz", + "integrity": "sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-obj": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", + "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-path-cwd": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/is-path-cwd/-/is-path-cwd-2.2.0.tgz", + "integrity": "sha512-w942bTcih8fdJPJmQHFzkS76NEP8Kzzvmw92cXsazb8intwLqPibPPdXf4ANdKV3rYMuuQYGIWtvz9JilB3NFQ==", + "engines": { + "node": ">=6" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-plain-obj": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-4.1.0.tgz", + "integrity": "sha512-+Pgi+vMuUNkJyExiMBt5IlFoMyKnr5zhJ4Uspz58WOhBF5QoIZkFyNHIbBAtHwzVAgk5RtndVNsDRN61/mmDqg==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-reference": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/is-reference/-/is-reference-3.0.2.tgz", + "integrity": "sha512-v3rht/LgVcsdZa3O2Nqs+NMowLOxeOm7Ay9+/ARQ2F+qEoANRcqrjAZKGN0v8ymUetZGgkp26LTnGT7H0Qo9Pg==", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/is-regexp": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", + "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-root": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-root/-/is-root-2.1.0.tgz", + "integrity": "sha512-AGOriNp96vNBd3HtU+RzFEc75FfR5ymiYv8E553I71SCeXBiMsVDUtdio1OEFvrPyLIQ9tVR5RxXIFe5PUFjMg==", + "engines": { + "node": ">=6" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==" + }, + "node_modules/is-wsl": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz", + "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==", + "dependencies": { + "is-docker": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-yarn-global": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.1.tgz", + "integrity": "sha512-/kppl+R+LO5VmhYSEWARUFjodS25D68gvj8W7z0I7OWhUla5xWu8KL6CtB2V0R6yqhnRgbcaREMr4EEM6htLPQ==", + "engines": { + "node": ">=12" + } + }, + "node_modules/isarray": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", + "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==" + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/jest-util": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.7.0.tgz", + "integrity": "sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==", + "dependencies": { + "@jest/types": "^29.6.3", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker": { + "version": "29.7.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.7.0.tgz", + "integrity": "sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==", + "dependencies": { + "@types/node": "*", + "jest-util": "^29.7.0", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/jiti": { + "version": "1.21.6", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.6.tgz", + "integrity": "sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==", + "bin": { + "jiti": "bin/jiti.js" + } + }, + "node_modules/joi": { + "version": "17.13.3", + "resolved": "https://registry.npmjs.org/joi/-/joi-17.13.3.tgz", + "integrity": "sha512-otDA4ldcIx+ZXsKHWmp0YizCweVRZG96J10b0FevjfuncLO1oX59THoAmHkNubYJ+9gWsYsp5k8v4ib6oDv1fA==", + "dependencies": { + "@hapi/hoek": "^9.3.0", + "@hapi/topo": "^5.1.0", + "@sideway/address": "^4.1.5", + "@sideway/formula": "^3.0.1", + "@sideway/pinpoint": "^2.0.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + }, + "node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsesc": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", + "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==" + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==" + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "engines": { + "node": ">=6" + } + }, + "node_modules/latest-version": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", + "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", + "dependencies": { + "package-json": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/launch-editor": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/launch-editor/-/launch-editor-2.8.0.tgz", + "integrity": "sha512-vJranOAJrI/llyWGRQqiDM+adrw+k83fvmmx3+nV47g3+36xM15jE+zyZ6Ffel02+xSvuM0b2GDRosXZkbb6wA==", + "dependencies": { + "picocolors": "^1.0.0", + "shell-quote": "^1.8.1" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "engines": { + "node": ">=6" + } + }, + "node_modules/lilconfig": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.2.tgz", + "integrity": "sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow==", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/antonk52" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==" + }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "dependencies": { + "uc.micro": "^2.0.0" + } + }, + "node_modules/loader-runner": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.0.tgz", + "integrity": "sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==", + "engines": { + "node": ">=6.11.5" + } + }, + "node_modules/loader-utils": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.4.tgz", + "integrity": "sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==", + "dependencies": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + }, + "engines": { + "node": ">=8.9.0" + } + }, + "node_modules/locate-path": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", + "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", + "dependencies": { + "p-locate": "^6.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + }, + "node_modules/lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==" + }, + "node_modules/lodash.memoize": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", + "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==" + }, + "node_modules/lodash.uniq": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", + "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==" + }, + "node_modules/longest-streak": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/longest-streak/-/longest-streak-3.1.0.tgz", + "integrity": "sha512-9Ri+o0JYgehTaVBBDoMqIl8GXtbWg711O3srftcHhZ0dqnETqLaoIK0x17fUw9rFSlK/0NlsKe0Ahhyl5pXE2g==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/lowercase-keys": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", + "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/markdown-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz", + "integrity": "sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/markdown-table": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/markdown-table/-/markdown-table-3.0.3.tgz", + "integrity": "sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/mdast-util-directive": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-directive/-/mdast-util-directive-3.0.0.tgz", + "integrity": "sha512-JUpYOqKI4mM3sZcNxmF/ox04XYFFkNwr0CFlrQIkCwbvH0xzMCqkMqAde9wRd80VAhaUrwFwKm2nxretdT1h7Q==", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.1.tgz", + "integrity": "sha512-SG21kZHGC3XRTSUhtofZkBzZTJNM5ecCi0SK2IMKmSXR8vO3peL+kb1O0z7Zl83jKtutG4k5Wv/W7V3/YHvzPA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "escape-string-regexp": "^5.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-find-and-replace/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-from-markdown": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.1.tgz", + "integrity": "sha512-aJEUyzZ6TzlsX2s5B4Of7lN7EQtAxvtradMMglCQDyaTFgse6CmtmdJ15ElnVRlCg1vpNyVtbem0PWzlNieZsA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-from-markdown/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/mdast-util-frontmatter": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-frontmatter/-/mdast-util-frontmatter-2.0.1.tgz", + "integrity": "sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "escape-string-regexp": "^5.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-frontmatter/node_modules/escape-string-regexp": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-5.0.0.tgz", + "integrity": "sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mdast-util-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm/-/mdast-util-gfm-3.0.0.tgz", + "integrity": "sha512-dgQEX5Amaq+DuUqf26jJqSK9qgixgd6rYDHAv4aTBuA92cTknZlKpPfa86Z/s8Dj8xsAQpFfBmPUHWJBWqS4Bw==", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-gfm-autolink-literal": "^2.0.0", + "mdast-util-gfm-footnote": "^2.0.0", + "mdast-util-gfm-strikethrough": "^2.0.0", + "mdast-util-gfm-table": "^2.0.0", + "mdast-util-gfm-task-list-item": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-autolink-literal/-/mdast-util-gfm-autolink-literal-2.0.0.tgz", + "integrity": "sha512-FyzMsduZZHSc3i0Px3PQcBT4WJY/X/RCtEJKuybiC6sjPqLv7h1yqAkmILZtuxMSsUyaLUWNp71+vQH2zqp5cg==", + "dependencies": { + "@types/mdast": "^4.0.0", + "ccount": "^2.0.0", + "devlop": "^1.0.0", + "mdast-util-find-and-replace": "^3.0.0", + "micromark-util-character": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/mdast-util-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/mdast-util-gfm-footnote": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-footnote/-/mdast-util-gfm-footnote-2.0.0.tgz", + "integrity": "sha512-5jOT2boTSVkMnQ7LTrd6n/18kqwjmuYqo7JUPe+tRCY6O7dAuTFMtTPauYYrMPpox9hlN0uOx/FL8XvEfG9/mQ==", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-strikethrough": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-strikethrough/-/mdast-util-gfm-strikethrough-2.0.0.tgz", + "integrity": "sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-table": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-table/-/mdast-util-gfm-table-2.0.0.tgz", + "integrity": "sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "markdown-table": "^3.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-gfm-task-list-item": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-gfm-task-list-item/-/mdast-util-gfm-task-list-item-2.0.0.tgz", + "integrity": "sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==", + "dependencies": { + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx/-/mdast-util-mdx-3.0.0.tgz", + "integrity": "sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==", + "dependencies": { + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-mdx-expression": "^2.0.0", + "mdast-util-mdx-jsx": "^3.0.0", + "mdast-util-mdxjs-esm": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-expression": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-expression/-/mdast-util-mdx-expression-2.0.0.tgz", + "integrity": "sha512-fGCu8eWdKUKNu5mohVGkhBXCXGnOTLuFqOvGMvdikr+J1w7lDJgxThOKpwRWzzbyXAU2hhSwsmssOY4yTokluw==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdx-jsx": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/mdast-util-mdx-jsx/-/mdast-util-mdx-jsx-3.1.2.tgz", + "integrity": "sha512-eKMQDeywY2wlHc97k5eD8VC+9ASMjN8ItEZQNGwJ6E0XWKiW/Z0V5/H8pvoXUf+y+Mj0VIgeRRbujBmFn4FTyA==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "devlop": "^1.1.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0", + "parse-entities": "^4.0.0", + "stringify-entities": "^4.0.0", + "unist-util-remove-position": "^5.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-mdxjs-esm": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/mdast-util-mdxjs-esm/-/mdast-util-mdxjs-esm-2.0.1.tgz", + "integrity": "sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==", + "dependencies": { + "@types/estree-jsx": "^1.0.0", + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "devlop": "^1.0.0", + "mdast-util-from-markdown": "^2.0.0", + "mdast-util-to-markdown": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-phrasing": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-4.1.0.tgz", + "integrity": "sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==", + "dependencies": { + "@types/mdast": "^4.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", + "integrity": "sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-markdown": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-markdown/-/mdast-util-to-markdown-2.1.0.tgz", + "integrity": "sha512-SR2VnIEdVNCJbP6y7kVTJgPLifdr8WEU440fQec7qHoHOUz/oJ2jmNRqdDQ3rbiStOXb2mCDGTuwsK5OPUgYlQ==", + "dependencies": { + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", + "longest-streak": "^3.0.0", + "mdast-util-phrasing": "^4.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark-util-decode-string": "^2.0.0", + "unist-util-visit": "^5.0.0", + "zwitch": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdast-util-to-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", + "dependencies": { + "@types/mdast": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/mdn-data": { + "version": "2.0.30", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", + "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==" + }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/memfs": { + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-3.5.3.tgz", + "integrity": "sha512-UERzLsxzllchadvbPs5aolHh65ISpKpM+ccLbOJ8/vvpBKmAWf+la7dXFy7Mr0ySHbdHrFv5kGFCUHHe6GFEmw==", + "dependencies": { + "fs-monkey": "^1.0.4" + }, + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", + "integrity": "sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==" + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/micromark": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.0.tgz", + "integrity": "sha512-o/sd0nMof8kYff+TqcDx3VSrgBTcZpSvYcAHIfHhv5VAuNmisCxjhx6YmxS8PFEpb9z5WKWKPdzf0jM23ro3RQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "@types/debug": "^4.0.0", + "debug": "^4.0.0", + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.1.tgz", + "integrity": "sha512-CUQyKr1e///ZODyD1U3xit6zXwy1a8q2a1S1HKtIlmgvurrEpaw/Y9y6KSIbF8P59cn/NjzHyO+Q2fAyYLQrAA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-core-commonmark/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-directive": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-3.0.0.tgz", + "integrity": "sha512-61OI07qpQrERc+0wEysLHMvoiO3s2R56x5u7glHq2Yqq6EHbH4dW25G9GfDdGCDYqA21KE6DWgNSzxSwHc2hSg==", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "parse-entities": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-directive/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-frontmatter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-frontmatter/-/micromark-extension-frontmatter-2.0.0.tgz", + "integrity": "sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==", + "dependencies": { + "fault": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-frontmatter/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-gfm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm/-/micromark-extension-gfm-3.0.0.tgz", + "integrity": "sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==", + "dependencies": { + "micromark-extension-gfm-autolink-literal": "^2.0.0", + "micromark-extension-gfm-footnote": "^2.0.0", + "micromark-extension-gfm-strikethrough": "^2.0.0", + "micromark-extension-gfm-table": "^2.0.0", + "micromark-extension-gfm-tagfilter": "^2.0.0", + "micromark-extension-gfm-task-list-item": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz", + "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-autolink-literal/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-gfm-footnote": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz", + "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==", + "dependencies": { + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-footnote/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-gfm-strikethrough": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-strikethrough/-/micromark-extension-gfm-strikethrough-2.1.0.tgz", + "integrity": "sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==", + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-strikethrough/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-gfm-table": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.0.tgz", + "integrity": "sha512-Ub2ncQv+fwD70/l4ou27b4YzfNaCJOvyX4HxXU15m7mpYY+rjuWzsLIPZHJL253Z643RpbcP1oeIJlQ/SKW67g==", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-table/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-gfm-tagfilter": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-tagfilter/-/micromark-extension-gfm-tagfilter-2.0.0.tgz", + "integrity": "sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-extension-gfm-task-list-item/-/micromark-extension-gfm-task-list-item-2.1.0.tgz", + "integrity": "sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==", + "dependencies": { + "devlop": "^1.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-gfm-task-list-item/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-mdx-expression": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-expression/-/micromark-extension-mdx-expression-3.0.0.tgz", + "integrity": "sha512-sI0nwhUDz97xyzqJAbHQhp5TfaxEvZZZ2JDqUo+7NvyIYG6BZ5CPPqj2ogUoPJlmXHBnyZUzISg9+oUmU6tUjQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-mdx-jsx": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-jsx/-/micromark-extension-mdx-jsx-3.0.0.tgz", + "integrity": "sha512-uvhhss8OGuzR4/N17L1JwvmJIpPhAd8oByMawEKx6NVdBCbesjH4t+vjEp3ZXft9DwvlKSD07fCeI44/N0Vf2w==", + "dependencies": { + "@types/acorn": "^4.0.0", + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "estree-util-is-identifier-name": "^3.0.0", + "micromark-factory-mdx-expression": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdx-jsx/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-extension-mdx-md": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdx-md/-/micromark-extension-mdx-md-2.0.0.tgz", + "integrity": "sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==", + "dependencies": { + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs/-/micromark-extension-mdxjs-3.0.0.tgz", + "integrity": "sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==", + "dependencies": { + "acorn": "^8.0.0", + "acorn-jsx": "^5.0.0", + "micromark-extension-mdx-expression": "^3.0.0", + "micromark-extension-mdx-jsx": "^3.0.0", + "micromark-extension-mdx-md": "^2.0.0", + "micromark-extension-mdxjs-esm": "^3.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-types": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/micromark-extension-mdxjs-esm/-/micromark-extension-mdxjs-esm-3.0.0.tgz", + "integrity": "sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==", + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-extension-mdxjs-esm/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-destination": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.0.tgz", + "integrity": "sha512-j9DGrQLm/Uhl2tCzcbLhy5kXsgkHUrjJHg4fFAeoMRwJmJerT9aw4FEhIbZStWN8A3qMwOp1uzHr4UL8AInxtA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-destination/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-label": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.0.tgz", + "integrity": "sha512-RR3i96ohZGde//4WSe/dJsxOX6vxIg9TimLAS3i4EhBAFx8Sm5SmqVfR8E87DPSR31nEAjZfbt91OMZWcNgdZw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-label/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-mdx-expression": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-factory-mdx-expression/-/micromark-factory-mdx-expression-2.0.1.tgz", + "integrity": "sha512-F0ccWIUHRLRrYp5TC9ZYXmZo+p2AM13ggbsW4T0b5CRKP8KHVRB8t4pwtBgTxtjRmwrK0Irwm7vs2JOZabHZfg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "@types/estree": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-events-to-acorn": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-position-from-estree": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-mdx-expression/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-space": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", + "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-factory-space/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-title": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.0.tgz", + "integrity": "sha512-jY8CSxmpWLOxS+t8W+FG3Xigc0RDQA9bKMY/EwILvsesiRniiVMejYTE4wumNc2f4UbAa4WsHqe3J1QS1sli+A==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-title/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-factory-whitespace": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.0.tgz", + "integrity": "sha512-28kbwaBjc5yAI1XadbdPYHX/eDnqaUFVikLwrO7FDnKG7lpgxnvk/XGRhX/PN0mOZ+dBSZ+LgunHS+6tYQAzhA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-factory-whitespace/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-character": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", + "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^1.0.0", + "micromark-util-types": "^1.0.0" + } + }, + "node_modules/micromark-util-character/node_modules/micromark-util-types": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", + "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-chunked": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.0.tgz", + "integrity": "sha512-anK8SWmNphkXdaKgz5hJvGa7l00qmcaUQoMYsBwDlSKFKjc6gjGXPDw3FNL3Nbwq5L8gE+RCbGqTw49FK5Qyvg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-chunked/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-classify-character": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.0.tgz", + "integrity": "sha512-S0ze2R9GH+fu41FA7pbSqNWObo/kzwf8rN/+IGlW/4tC6oACOs8B++bh+i9bVyNnwCcuksbFwsBme5OCKXCwIw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-classify-character/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-combine-extensions": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.0.tgz", + "integrity": "sha512-vZZio48k7ON0fVS3CUgFatWHoKbbLTK/rT7pzpJ4Bjp5JjkZeasRfrS9wsBdDJK2cJLHMckXZdzPSSr1B8a4oQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.1.tgz", + "integrity": "sha512-bmkNc7z8Wn6kgjZmVHOX3SowGmVdhYS7yBpMnuMnPzDq/6xwVA604DuOXMZTO1lvq01g+Adfa0pE2UKGlxL1XQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-numeric-character-reference/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-decode-string": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.0.tgz", + "integrity": "sha512-r4Sc6leeUTn3P6gk20aFMj2ntPwn6qpDZqWvYmAG6NgvFTIlj4WtrAudLi65qYoaGdXYViXYw2pkmn7QnIFasA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "decode-named-character-reference": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-decode-string/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-encode": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.0.tgz", + "integrity": "sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-events-to-acorn": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-events-to-acorn/-/micromark-util-events-to-acorn-2.0.2.tgz", + "integrity": "sha512-Fk+xmBrOv9QZnEDguL9OI9/NQQp6Hz4FuQ4YmCb/5V7+9eAh1s6AYSvL20kHkD67YIg7EpE54TiSlcsf3vyZgA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "@types/acorn": "^4.0.0", + "@types/estree": "^1.0.0", + "@types/unist": "^3.0.0", + "devlop": "^1.0.0", + "estree-util-visit": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "vfile-message": "^4.0.0" + } + }, + "node_modules/micromark-util-events-to-acorn/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-html-tag-name": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.0.tgz", + "integrity": "sha512-xNn4Pqkj2puRhKdKTm8t1YHC/BAjx6CEwRFXntTaRf/x16aqka6ouVoutm+QdkISTlT7e2zU7U4ZdlDLJd2Mcw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-normalize-identifier": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.0.tgz", + "integrity": "sha512-2xhYT0sfo85FMrUPtHcPo2rrp1lwbDEEzpx7jiH2xXJLqBuy4H0GgXk5ToU8IEwoROtXuL8ND0ttVa4rNqYK3w==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-normalize-identifier/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-resolve-all": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.0.tgz", + "integrity": "sha512-6KU6qO7DZ7GJkaCgwBNtplXCvGkJToU86ybBAUdavvgsCiG8lSSvYxr9MhwmQ+udpzywHsl4RpGJsYWG1pDOcA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.0.tgz", + "integrity": "sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-sanitize-uri/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-subtokenize": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.0.1.tgz", + "integrity": "sha512-jZNtiFl/1aY73yS3UGQkutD0UbhTt68qnRpw2Pifmz5wV9h8gOVsN70v+Lq/f1rKaU/W8pxRe8y8Q9FX1AOe1Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-subtokenize/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-symbol": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", + "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark-util-types": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.0.tgz", + "integrity": "sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromark/node_modules/micromark-factory-space": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-character": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", + "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark/node_modules/micromark-util-symbol": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ] + }, + "node_modules/micromatch": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", + "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.33.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", + "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.18", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", + "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", + "dependencies": { + "mime-db": "~1.33.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "engines": { + "node": ">=6" + } + }, + "node_modules/mimic-response": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-4.0.0.tgz", + "integrity": "sha512-e5ISH9xMYU0DzrT+jl8q2ze9D6eWBto+I8CNpe+VI+K2J/F/k3PdkdTdz4wvGVH4NTpo+NRYTVIuMQEMMcsLqg==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/mini-css-extract-plugin": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-2.9.0.tgz", + "integrity": "sha512-Zs1YsZVfemekSZG+44vBsYTLQORkPMwnlv+aehcxK/NLKC+EGhDB39/YePYYqx/sTk6NnYpuqikhSn7+JIevTA==", + "dependencies": { + "schema-utils": "^4.0.0", + "tapable": "^2.2.1" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.0.0" + } + }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.1.tgz", + "integrity": "sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==" + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mrmime": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mrmime/-/mrmime-2.0.0.tgz", + "integrity": "sha512-eu38+hdgojoyq63s+yTpN4XMBdt5l8HhMhc4VKLO9KM5caLIBvUm4thi7fFaxyTmCKeNnXZ5pAlBwCUnhA09uw==", + "engines": { + "node": ">=10" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" + }, + "node_modules/multicast-dns": { + "version": "7.2.5", + "resolved": "https://registry.npmjs.org/multicast-dns/-/multicast-dns-7.2.5.tgz", + "integrity": "sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==", + "dependencies": { + "dns-packet": "^5.2.2", + "thunky": "^1.0.2" + }, + "bin": { + "multicast-dns": "cli.js" + } + }, + "node_modules/nanoid": { + "version": "3.3.7", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", + "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==" + }, + "node_modules/no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "dependencies": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, + "node_modules/node-emoji": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-2.1.3.tgz", + "integrity": "sha512-E2WEOVsgs7O16zsURJ/eH8BqhF029wGpEOnv7Urwdo2wmQanOACwJQh0devF9D9RhoZru0+9JXIS0dBXIAz+lA==", + "dependencies": { + "@sindresorhus/is": "^4.6.0", + "char-regex": "^1.0.2", + "emojilib": "^2.4.0", + "skin-tone": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/node-forge": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.1.tgz", + "integrity": "sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==", + "engines": { + "node": ">= 6.13.0" + } + }, + "node_modules/node-releases": { + "version": "2.0.14", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.14.tgz", + "integrity": "sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw==" + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/normalize-range": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/normalize-range/-/normalize-range-0.1.2.tgz", + "integrity": "sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/normalize-url": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-8.0.1.tgz", + "integrity": "sha512-IO9QvjUMWxPQQhs60oOu10CRkWCiZzSUkzbXGGV9pviYl1fXYcvkzQ5jV9z8Y6un8ARoVRl4EtC6v6jNqbaJ/w==", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nprogress": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/nprogress/-/nprogress-0.2.0.tgz", + "integrity": "sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==" + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.2.tgz", + "integrity": "sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", + "dependencies": { + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/obuf": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/obuf/-/obuf-1.1.2.tgz", + "integrity": "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==" + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/on-headers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.0.2.tgz", + "integrity": "sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/open": { + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz", + "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==", + "dependencies": { + "define-lazy-prop": "^2.0.0", + "is-docker": "^2.1.1", + "is-wsl": "^2.2.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/opener": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/opener/-/opener-1.5.2.tgz", + "integrity": "sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==", + "bin": { + "opener": "bin/opener-bin.js" + } + }, + "node_modules/p-cancelable": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", + "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", + "engines": { + "node": ">=12.20" + } + }, + "node_modules/p-limit": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", + "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", + "dependencies": { + "yocto-queue": "^1.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", + "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", + "dependencies": { + "p-limit": "^4.0.0" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-map": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", + "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", + "dependencies": { + "aggregate-error": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-retry": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-4.6.2.tgz", + "integrity": "sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ==", + "dependencies": { + "@types/retry": "0.12.0", + "retry": "^0.13.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "engines": { + "node": ">=6" + } + }, + "node_modules/package-json": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.1.tgz", + "integrity": "sha512-cbH9IAIJHNj9uXi196JVsRlt7cHKak6u/e6AkL/bkRelZ7rlL3X1YKxsZwa36xipOEKAsdtmaG6aAJoM1fx2zA==", + "dependencies": { + "got": "^12.1.0", + "registry-auth-token": "^5.0.1", + "registry-url": "^6.0.0", + "semver": "^7.3.7" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/param-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", + "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-entities": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.1.tgz", + "integrity": "sha512-SWzvYcSJh4d/SGLIOQfZ/CoNv6BTlI6YEQ7Nj82oDVnRpwe/Z/F1EMx42x3JAOwGBlCjeCH0BRJQbQ/opHL17w==", + "dependencies": { + "@types/unist": "^2.0.0", + "character-entities": "^2.0.0", + "character-entities-legacy": "^3.0.0", + "character-reference-invalid": "^2.0.0", + "decode-named-character-reference": "^1.0.0", + "is-alphanumerical": "^2.0.0", + "is-decimal": "^2.0.0", + "is-hexadecimal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/parse-entities/node_modules/@types/unist": { + "version": "2.0.10", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.10.tgz", + "integrity": "sha512-IfYcSBWE3hLpBg8+X2SEa8LVkJdJEkT2Ese2aaLs3ptGdVtABxndrMaxuFlQ1qdFf9Q5rDvDpxI3WwgvKFAsQA==" + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-numeric-range": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz", + "integrity": "sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==" + }, + "node_modules/parse5": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.1.2.tgz", + "integrity": "sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw==", + "dependencies": { + "entities": "^4.4.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.0.0.tgz", + "integrity": "sha512-B77tOZrqqfUfnVcOrUvfdLbz4pu4RopLD/4vmu3HUPswwTA8OH0EMW9BlWR2B0RCoiZRAHEUu7IxeP1Pd1UU+g==", + "dependencies": { + "domhandler": "^5.0.2", + "parse5": "^7.0.0" + }, + "funding": { + "url": "https://github.com/inikulin/parse5?sponsor=1" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/pascal-case": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", + "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/path-exists": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", + "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-is-inside": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", + "integrity": "sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==" + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==" + }, + "node_modules/path-to-regexp": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", + "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", + "dependencies": { + "isarray": "0.0.1" + } + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "engines": { + "node": ">=8" + } + }, + "node_modules/periscopic": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/periscopic/-/periscopic-3.1.0.tgz", + "integrity": "sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-walker": "^3.0.0", + "is-reference": "^3.0.0" + } + }, + "node_modules/picocolors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", + "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pkg-dir": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-7.0.0.tgz", + "integrity": "sha512-Ie9z/WINcxxLp27BKOCHGde4ITq9UklYKDzVo1nhk5sqGEXU3FpkwP5GM2voTGJkGd9B3Otl+Q4uwSOeSUtOBA==", + "dependencies": { + "find-up": "^6.3.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-up": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pkg-up/-/pkg-up-3.1.0.tgz", + "integrity": "sha512-nDywThFk1i4BQK4twPQ6TA4RT8bDY96yeuCVBWL3ePARCiEKDRSrNGbFIgUJpLp+XeIR65v8ra7WuJOFUBtkMA==", + "dependencies": { + "find-up": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/pkg-up/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-up/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-up/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-up/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/pkg-up/node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==", + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss": { + "version": "8.4.39", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.39.tgz", + "integrity": "sha512-0vzE+lAiG7hZl1/9I8yzKLx3aR9Xbof3fBHKunvMfOCYAtMhrsnccJY2iTURb9EZd5+pLuiNV9/c/GZJOHsgIw==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "nanoid": "^3.3.7", + "picocolors": "^1.0.1", + "source-map-js": "^1.2.0" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/postcss-calc": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/postcss-calc/-/postcss-calc-9.0.1.tgz", + "integrity": "sha512-TipgjGyzP5QzEhsOZUaIkeO5mKeMFpebWzRogWG/ysonUlnHcq5aJe0jOjpfzUU8PeSaBQnrE8ehR0QA5vs8PQ==", + "dependencies": { + "postcss-selector-parser": "^6.0.11", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.2.2" + } + }, + "node_modules/postcss-colormin": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-colormin/-/postcss-colormin-6.1.0.tgz", + "integrity": "sha512-x9yX7DOxeMAR+BgGVnNSAxmAj98NX/YxEMNFP+SDCEeNLb2r3i6Hh1ksMsnW8Ub5SLCpbescQqn9YEbE9554Sw==", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "colord": "^2.9.3", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-convert-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-convert-values/-/postcss-convert-values-6.1.0.tgz", + "integrity": "sha512-zx8IwP/ts9WvUM6NkVSkiU902QZL1bwPhaVaLynPtCsOTqp+ZKbNi+s6XJg3rfqpKGA/oc7Oxk5t8pOQJcwl/w==", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-comments": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-comments/-/postcss-discard-comments-6.0.2.tgz", + "integrity": "sha512-65w/uIqhSBBfQmYnG92FO1mWZjJ4GL5b8atm5Yw2UgrwD7HiNiSSNwJor1eCFGzUgYnN/iIknhNRVqjrrpuglw==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-duplicates": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-duplicates/-/postcss-discard-duplicates-6.0.3.tgz", + "integrity": "sha512-+JA0DCvc5XvFAxwx6f/e68gQu/7Z9ud584VLmcgto28eB8FqSFZwtrLwB5Kcp70eIoWP/HXqz4wpo8rD8gpsTw==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-empty": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-discard-empty/-/postcss-discard-empty-6.0.3.tgz", + "integrity": "sha512-znyno9cHKQsK6PtxL5D19Fj9uwSzC2mB74cpT66fhgOadEUPyXFkbgwm5tvc3bt3NAy8ltE5MrghxovZRVnOjQ==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-overridden": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-discard-overridden/-/postcss-discard-overridden-6.0.2.tgz", + "integrity": "sha512-j87xzI4LUggC5zND7KdjsI25APtyMuynXZSujByMaav2roV6OZX+8AaCUcZSWqckZpjAjRyFDdpqybgjFO0HJQ==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-discard-unused": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-discard-unused/-/postcss-discard-unused-6.0.5.tgz", + "integrity": "sha512-wHalBlRHkaNnNwfC8z+ppX57VhvS+HWgjW508esjdaEYr3Mx7Gnn2xA4R/CKf5+Z9S5qsqC+Uzh4ueENWwCVUA==", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-loader": { + "version": "7.3.4", + "resolved": "https://registry.npmjs.org/postcss-loader/-/postcss-loader-7.3.4.tgz", + "integrity": "sha512-iW5WTTBSC5BfsBJ9daFMPVrLT36MrNiC6fqOZTTaHjBNX6Pfd5p+hSBqe/fEeNd7pc13QiAyGt7VdGMw4eRC4A==", + "dependencies": { + "cosmiconfig": "^8.3.5", + "jiti": "^1.20.0", + "semver": "^7.5.4" + }, + "engines": { + "node": ">= 14.15.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "postcss": "^7.0.0 || ^8.0.1", + "webpack": "^5.0.0" + } + }, + "node_modules/postcss-merge-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-merge-idents/-/postcss-merge-idents-6.0.3.tgz", + "integrity": "sha512-1oIoAsODUs6IHQZkLQGO15uGEbK3EAl5wi9SS8hs45VgsxQfMnxvt+L+zIr7ifZFIH14cfAeVe2uCTa+SPRa3g==", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-longhand": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/postcss-merge-longhand/-/postcss-merge-longhand-6.0.5.tgz", + "integrity": "sha512-5LOiordeTfi64QhICp07nzzuTDjNSO8g5Ksdibt44d+uvIIAE1oZdRn8y/W5ZtYgRH/lnLDlvi9F8btZcVzu3w==", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "stylehacks": "^6.1.1" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-merge-rules": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/postcss-merge-rules/-/postcss-merge-rules-6.1.1.tgz", + "integrity": "sha512-KOdWF0gju31AQPZiD+2Ar9Qjowz1LTChSjFFbS+e2sFgc4uHOp3ZvVX4sNeTlk0w2O31ecFGgrFzhO0RSWbWwQ==", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0", + "cssnano-utils": "^4.0.2", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-font-values": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-font-values/-/postcss-minify-font-values-6.1.0.tgz", + "integrity": "sha512-gklfI/n+9rTh8nYaSJXlCo3nOKqMNkxuGpTn/Qm0gstL3ywTr9/WRKznE+oy6fvfolH6dF+QM4nCo8yPLdvGJg==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-gradients": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-minify-gradients/-/postcss-minify-gradients-6.0.3.tgz", + "integrity": "sha512-4KXAHrYlzF0Rr7uc4VrfwDJ2ajrtNEpNEuLxFgwkhFZ56/7gaE4Nr49nLsQDZyUe+ds+kEhf+YAUolJiYXF8+Q==", + "dependencies": { + "colord": "^2.9.3", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-params": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-minify-params/-/postcss-minify-params-6.1.0.tgz", + "integrity": "sha512-bmSKnDtyyE8ujHQK0RQJDIKhQ20Jq1LYiez54WiaOoBtcSuflfK3Nm596LvbtlFcpipMjgClQGyGr7GAs+H1uA==", + "dependencies": { + "browserslist": "^4.23.0", + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-minify-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-minify-selectors/-/postcss-minify-selectors-6.0.4.tgz", + "integrity": "sha512-L8dZSwNLgK7pjTto9PzWRoMbnLq5vsZSTu8+j1P/2GB8qdtGQfn+K1uSvFgYvgh83cbyxT5m43ZZhUMTJDSClQ==", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-modules-extract-imports": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/postcss-modules-extract-imports/-/postcss-modules-extract-imports-3.1.0.tgz", + "integrity": "sha512-k3kNe0aNFQDAZGbin48pL2VNidTF0w4/eASDsxlyspobzU3wZQLOGj7L9gfRe0Jo9/4uud09DsjFNH7winGv8Q==", + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-local-by-default": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/postcss-modules-local-by-default/-/postcss-modules-local-by-default-4.0.5.tgz", + "integrity": "sha512-6MieY7sIfTK0hYfafw1OMEG+2bg8Q1ocHCpoWLqOKj3JXlKu4G7btkmM/B7lFubYkYWmRSPLZi5chid63ZaZYw==", + "dependencies": { + "icss-utils": "^5.0.0", + "postcss-selector-parser": "^6.0.2", + "postcss-value-parser": "^4.1.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-scope": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/postcss-modules-scope/-/postcss-modules-scope-3.2.0.tgz", + "integrity": "sha512-oq+g1ssrsZOsx9M96c5w8laRmvEu9C3adDSjI8oTcbfkrTE8hx/zfyobUoWIxaKPO8bt6S62kxpw5GqypEw1QQ==", + "dependencies": { + "postcss-selector-parser": "^6.0.4" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-modules-values": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/postcss-modules-values/-/postcss-modules-values-4.0.0.tgz", + "integrity": "sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==", + "dependencies": { + "icss-utils": "^5.0.0" + }, + "engines": { + "node": "^10 || ^12 || >= 14" + }, + "peerDependencies": { + "postcss": "^8.1.0" + } + }, + "node_modules/postcss-normalize-charset": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-charset/-/postcss-normalize-charset-6.0.2.tgz", + "integrity": "sha512-a8N9czmdnrjPHa3DeFlwqst5eaL5W8jYu3EBbTTkI5FHkfMhFZh1EGbku6jhHhIzTA6tquI2P42NtZ59M/H/kQ==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-display-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-display-values/-/postcss-normalize-display-values-6.0.2.tgz", + "integrity": "sha512-8H04Mxsb82ON/aAkPeq8kcBbAtI5Q2a64X/mnRRfPXBq7XeogoQvReqxEfc0B4WPq1KimjezNC8flUtC3Qz6jg==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-positions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-positions/-/postcss-normalize-positions-6.0.2.tgz", + "integrity": "sha512-/JFzI441OAB9O7VnLA+RtSNZvQ0NCFZDOtp6QPFo1iIyawyXg0YI3CYM9HBy1WvwCRHnPep/BvI1+dGPKoXx/Q==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-repeat-style": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-repeat-style/-/postcss-normalize-repeat-style-6.0.2.tgz", + "integrity": "sha512-YdCgsfHkJ2jEXwR4RR3Tm/iOxSfdRt7jplS6XRh9Js9PyCR/aka/FCb6TuHT2U8gQubbm/mPmF6L7FY9d79VwQ==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-string": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-string/-/postcss-normalize-string-6.0.2.tgz", + "integrity": "sha512-vQZIivlxlfqqMp4L9PZsFE4YUkWniziKjQWUtsxUiVsSSPelQydwS8Wwcuw0+83ZjPWNTl02oxlIvXsmmG+CiQ==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-timing-functions": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-timing-functions/-/postcss-normalize-timing-functions-6.0.2.tgz", + "integrity": "sha512-a+YrtMox4TBtId/AEwbA03VcJgtyW4dGBizPl7e88cTFULYsprgHWTbfyjSLyHeBcK/Q9JhXkt2ZXiwaVHoMzA==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-unicode": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-normalize-unicode/-/postcss-normalize-unicode-6.1.0.tgz", + "integrity": "sha512-QVC5TQHsVj33otj8/JD869Ndr5Xcc/+fwRh4HAsFsAeygQQXm+0PySrKbr/8tkDKzW+EVT3QkqZMfFrGiossDg==", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-url": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-url/-/postcss-normalize-url-6.0.2.tgz", + "integrity": "sha512-kVNcWhCeKAzZ8B4pv/DnrU1wNh458zBNp8dh4y5hhxih5RZQ12QWMuQrDgPRw3LRl8mN9vOVfHl7uhvHYMoXsQ==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-normalize-whitespace": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-normalize-whitespace/-/postcss-normalize-whitespace-6.0.2.tgz", + "integrity": "sha512-sXZ2Nj1icbJOKmdjXVT9pnyHQKiSAyuNQHSgRCUgThn2388Y9cGVDR+E9J9iAYbSbLHI+UUwLVl1Wzco/zgv0Q==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-ordered-values": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-ordered-values/-/postcss-ordered-values-6.0.2.tgz", + "integrity": "sha512-VRZSOB+JU32RsEAQrO94QPkClGPKJEL/Z9PCBImXMhIeK5KAYo6slP/hBYlLgrCjFxyqvn5VC81tycFEDBLG1Q==", + "dependencies": { + "cssnano-utils": "^4.0.2", + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-idents": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-reduce-idents/-/postcss-reduce-idents-6.0.3.tgz", + "integrity": "sha512-G3yCqZDpsNPoQgbDUy3T0E6hqOQ5xigUtBQyrmq3tn2GxlyiL0yyl7H+T8ulQR6kOcHJ9t7/9H4/R2tv8tJbMA==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-initial": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-reduce-initial/-/postcss-reduce-initial-6.1.0.tgz", + "integrity": "sha512-RarLgBK/CrL1qZags04oKbVbrrVK2wcxhvta3GCxrZO4zveibqbRPmm2VI8sSgCXwoUHEliRSbOfpR0b/VIoiw==", + "dependencies": { + "browserslist": "^4.23.0", + "caniuse-api": "^3.0.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-reduce-transforms": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-reduce-transforms/-/postcss-reduce-transforms-6.0.2.tgz", + "integrity": "sha512-sB+Ya++3Xj1WaT9+5LOOdirAxP7dJZms3GRcYheSPi1PiTMigsxHAdkrbItHxwYHr4kt1zL7mmcHstgMYT+aiA==", + "dependencies": { + "postcss-value-parser": "^4.2.0" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-selector-parser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.0.tgz", + "integrity": "sha512-UMz42UD0UY0EApS0ZL9o1XnLhSTtvvvLe5Dc2H2O56fvRZi+KulDyf5ctDhhtYJBGKStV2FL1fy6253cmLgqVQ==", + "dependencies": { + "cssesc": "^3.0.0", + "util-deprecate": "^1.0.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/postcss-sort-media-queries": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/postcss-sort-media-queries/-/postcss-sort-media-queries-5.2.0.tgz", + "integrity": "sha512-AZ5fDMLD8SldlAYlvi8NIqo0+Z8xnXU2ia0jxmuhxAU+Lqt9K+AlmLNJ/zWEnE9x+Zx3qL3+1K20ATgNOr3fAA==", + "dependencies": { + "sort-css-media-queries": "2.2.0" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "postcss": "^8.4.23" + } + }, + "node_modules/postcss-svgo": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/postcss-svgo/-/postcss-svgo-6.0.3.tgz", + "integrity": "sha512-dlrahRmxP22bX6iKEjOM+c8/1p+81asjKT+V5lrgOH944ryx/OHpclnIbGsKVd3uWOXFLYJwCVf0eEkJGvO96g==", + "dependencies": { + "postcss-value-parser": "^4.2.0", + "svgo": "^3.2.0" + }, + "engines": { + "node": "^14 || ^16 || >= 18" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-unique-selectors": { + "version": "6.0.4", + "resolved": "https://registry.npmjs.org/postcss-unique-selectors/-/postcss-unique-selectors-6.0.4.tgz", + "integrity": "sha512-K38OCaIrO8+PzpArzkLKB42dSARtC2tmG6PvD4b1o1Q2E9Os8jzfWFfSy/rixsHwohtsDdFtAWGjFVFUdwYaMg==", + "dependencies": { + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/postcss-value-parser": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz", + "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==" + }, + "node_modules/postcss-zindex": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/postcss-zindex/-/postcss-zindex-6.0.2.tgz", + "integrity": "sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg==", + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/pretty-error": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz", + "integrity": "sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==", + "dependencies": { + "lodash": "^4.17.20", + "renderkid": "^3.0.0" + } + }, + "node_modules/pretty-time": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/pretty-time/-/pretty-time-1.1.0.tgz", + "integrity": "sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==", + "engines": { + "node": ">=4" + } + }, + "node_modules/prism-react-renderer": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/prism-react-renderer/-/prism-react-renderer-2.3.1.tgz", + "integrity": "sha512-Rdf+HzBLR7KYjzpJ1rSoxT9ioO85nZngQEoFIhL07XhtJHlCU3SOz0GJ6+qvMyQe0Se+BV3qpe6Yd/NmQF5Juw==", + "dependencies": { + "@types/prismjs": "^1.26.0", + "clsx": "^2.0.0" + }, + "peerDependencies": { + "react": ">=16.0.0" + } + }, + "node_modules/prismjs": { + "version": "1.29.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.29.0.tgz", + "integrity": "sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q==", + "engines": { + "node": ">=6" + } + }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==" + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/property-information": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-6.5.0.tgz", + "integrity": "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==" + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/proxy-addr/node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/punycode": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", + "integrity": "sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==" + }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/pupa": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", + "integrity": "sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug==", + "dependencies": { + "escape-goat": "^4.0.0" + }, + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/qs": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.0.tgz", + "integrity": "sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==", + "dependencies": { + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/queue": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/queue/-/queue-6.0.2.tgz", + "integrity": "sha512-iHZWu+q3IdFZFX36ro/lKBkSvfkztY5Y7HMiPlOUjhupPcG2JMfst2KKEpu5XndviX/3UhFbRngUPNKtgvtZiA==", + "dependencies": { + "inherits": "~2.0.3" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/quick-lru": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", + "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/randombytes": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", + "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "dependencies": { + "safe-buffer": "^5.1.0" + } + }, + "node_modules/range-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", + "integrity": "sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz", + "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==", + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/raw-body/node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/rc": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" + }, + "bin": { + "rc": "cli.js" + } + }, + "node_modules/rc/node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", + "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", + "dependencies": { + "loose-envify": "^1.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/react-dev-utils": { + "version": "12.0.1", + "resolved": "https://registry.npmjs.org/react-dev-utils/-/react-dev-utils-12.0.1.tgz", + "integrity": "sha512-84Ivxmr17KjUupyqzFode6xKhjwuEJDROWKJy/BthkL7Wn6NJ8h4WE6k/exAv6ImS+0oZLRRW5j/aINMHyeGeQ==", + "dependencies": { + "@babel/code-frame": "^7.16.0", + "address": "^1.1.2", + "browserslist": "^4.18.1", + "chalk": "^4.1.2", + "cross-spawn": "^7.0.3", + "detect-port-alt": "^1.1.6", + "escape-string-regexp": "^4.0.0", + "filesize": "^8.0.6", + "find-up": "^5.0.0", + "fork-ts-checker-webpack-plugin": "^6.5.0", + "global-modules": "^2.0.0", + "globby": "^11.0.4", + "gzip-size": "^6.0.0", + "immer": "^9.0.7", + "is-root": "^2.1.0", + "loader-utils": "^3.2.0", + "open": "^8.4.0", + "pkg-up": "^3.1.0", + "prompts": "^2.4.2", + "react-error-overlay": "^6.0.11", + "recursive-readdir": "^2.2.2", + "shell-quote": "^1.7.3", + "strip-ansi": "^6.0.1", + "text-table": "^0.2.0" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/react-dev-utils/node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/react-dev-utils/node_modules/loader-utils": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-3.3.1.tgz", + "integrity": "sha512-FMJTLMXfCLMLfJxcX9PFqX5qD88Z5MRGaZCVzfuqeZSPsyiBzs+pahDQjbIWz2QIzPZz0NX9Zy4FX3lmK6YHIg==", + "engines": { + "node": ">= 12.13.0" + } + }, + "node_modules/react-dev-utils/node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/react-dev-utils/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/react-dev-utils/node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/react-dev-utils/node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "engines": { + "node": ">=8" + } + }, + "node_modules/react-dev-utils/node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/react-dom": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", + "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", + "dependencies": { + "loose-envify": "^1.1.0", + "scheduler": "^0.23.2" + }, + "peerDependencies": { + "react": "^18.3.1" + } + }, + "node_modules/react-error-overlay": { + "version": "6.0.11", + "resolved": "https://registry.npmjs.org/react-error-overlay/-/react-error-overlay-6.0.11.tgz", + "integrity": "sha512-/6UZ2qgEyH2aqzYZgQPxEnz33NJ2gNsnHA2o5+o4wW9bLM/JYQitNP9xPhsXwC08hMMovfGe/8retsdDsczPRg==" + }, + "node_modules/react-fast-compare": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.2.tgz", + "integrity": "sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==" + }, + "node_modules/react-helmet-async": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/react-helmet-async/-/react-helmet-async-1.3.0.tgz", + "integrity": "sha512-9jZ57/dAn9t3q6hneQS0wukqC2ENOBgMNVEhb/ZG9ZSxUetzVIw4iAmEU38IaVg3QGYauQPhSeUTuIUtFglWpg==", + "dependencies": { + "@babel/runtime": "^7.12.5", + "invariant": "^2.2.4", + "prop-types": "^15.7.2", + "react-fast-compare": "^3.2.0", + "shallowequal": "^1.1.0" + }, + "peerDependencies": { + "react": "^16.6.0 || ^17.0.0 || ^18.0.0", + "react-dom": "^16.6.0 || ^17.0.0 || ^18.0.0" + } + }, + "node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + }, + "node_modules/react-json-view-lite": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/react-json-view-lite/-/react-json-view-lite-1.4.0.tgz", + "integrity": "sha512-wh6F6uJyYAmQ4fK0e8dSQMEWuvTs2Wr3el3sLD9bambX1+pSWUVXIz1RFaoy3TI1mZ0FqdpKq9YgbgTTgyrmXA==", + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "react": "^16.13.1 || ^17.0.0 || ^18.0.0" + } + }, + "node_modules/react-loadable": { + "name": "@docusaurus/react-loadable", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", + "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", + "dependencies": { + "@types/react": "*" + }, + "peerDependencies": { + "react": "*" + } + }, + "node_modules/react-loadable-ssr-addon-v5-slorber": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/react-loadable-ssr-addon-v5-slorber/-/react-loadable-ssr-addon-v5-slorber-1.0.1.tgz", + "integrity": "sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A==", + "dependencies": { + "@babel/runtime": "^7.10.3" + }, + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "react-loadable": "*", + "webpack": ">=4.41.1 || 5.x" + } + }, + "node_modules/react-router": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", + "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "hoist-non-react-statics": "^3.1.0", + "loose-envify": "^1.3.1", + "path-to-regexp": "^1.7.0", + "prop-types": "^15.6.2", + "react-is": "^16.6.0", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/react-router-config": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/react-router-config/-/react-router-config-5.1.1.tgz", + "integrity": "sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==", + "dependencies": { + "@babel/runtime": "^7.1.2" + }, + "peerDependencies": { + "react": ">=15", + "react-router": ">=5" + } + }, + "node_modules/react-router-dom": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", + "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", + "dependencies": { + "@babel/runtime": "^7.12.13", + "history": "^4.9.0", + "loose-envify": "^1.3.1", + "prop-types": "^15.6.2", + "react-router": "5.3.4", + "tiny-invariant": "^1.0.2", + "tiny-warning": "^1.0.0" + }, + "peerDependencies": { + "react": ">=15" + } + }, + "node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/reading-time": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/reading-time/-/reading-time-1.5.0.tgz", + "integrity": "sha512-onYyVhBNr4CmAxFsKS7bz+uTLRakypIe4R+5A824vBSkQy/hB3fZepoVEf8OVAxzLvK+H/jm9TzpI3ETSm64Kg==" + }, + "node_modules/rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha512-HFM8rkZ+i3zrV+4LQjwQ0W+ez98pApMGM3HUrN04j3CqzPOzl9nmP15Y8YXNm8QHGv/eacOVEjqhmWpkRV0NAw==", + "dependencies": { + "resolve": "^1.1.6" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/recursive-readdir": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/recursive-readdir/-/recursive-readdir-2.2.3.tgz", + "integrity": "sha512-8HrF5ZsXk5FAH9dgsx3BlUer73nIhuj+9OrQwEbLTPOBzGkL1lsFCR01am+v+0m2Cmbs1nP12hLDl5FA7EszKA==", + "dependencies": { + "minimatch": "^3.0.5" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==" + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.1.tgz", + "integrity": "sha512-X007RyZLsCJVVrjgEFVpLUTZwyOZk3oiL75ZcuYjlIWd6rNJtOjkBwQc5AsRrpbKVkxN6sklw/k/9m2jJYOf8Q==", + "dependencies": { + "regenerate": "^1.4.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regenerator-runtime": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz", + "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==" + }, + "node_modules/regenerator-transform": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/regenerator-transform/-/regenerator-transform-0.15.2.tgz", + "integrity": "sha512-hfMp2BoF0qOk3uc5V20ALGDS2ddjQaLrdl7xrGXvAIow7qeWRM2VA2HuCHkUKk9slq3VwEwLNK3DFBqDfPGYtg==", + "dependencies": { + "@babel/runtime": "^7.8.4" + } + }, + "node_modules/regexpu-core": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-5.3.2.tgz", + "integrity": "sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ==", + "dependencies": { + "@babel/regjsgen": "^0.8.0", + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.1.0", + "regjsparser": "^0.9.1", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/registry-auth-token": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.0.2.tgz", + "integrity": "sha512-o/3ikDxtXaA59BmZuZrJZDJv8NMDGSj+6j6XaeBmHw8eY1i1qd9+6H+LjVvQXx3HN6aRCGa1cUdJ9RaJZUugnQ==", + "dependencies": { + "@pnpm/npm-conf": "^2.1.0" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/registry-url": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", + "dependencies": { + "rc": "1.2.8" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/regjsparser": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.9.1.tgz", + "integrity": "sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ==", + "dependencies": { + "jsesc": "~0.5.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/regjsparser/node_modules/jsesc": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz", + "integrity": "sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==", + "bin": { + "jsesc": "bin/jsesc" + } + }, + "node_modules/rehype-raw": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/rehype-raw/-/rehype-raw-7.0.0.tgz", + "integrity": "sha512-/aE8hCfKlQeA8LmyeyQvQF3eBiLRGNlfBJEvWH7ivp9sBqs7TNqBL5X3v157rM4IFETqDnIOO+z5M/biZbo9Ww==", + "dependencies": { + "@types/hast": "^3.0.0", + "hast-util-raw": "^9.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/relateurl": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/relateurl/-/relateurl-0.2.7.tgz", + "integrity": "sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/remark-directive": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/remark-directive/-/remark-directive-3.0.0.tgz", + "integrity": "sha512-l1UyWJ6Eg1VPU7Hm/9tt0zKtReJQNOA4+iDMAxTyZNWnJnFlbS/7zhiel/rogTLQ2vMYwDzSJa4BiVNqGlqIMA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-directive": "^3.0.0", + "micromark-extension-directive": "^3.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-emoji": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/remark-emoji/-/remark-emoji-4.0.1.tgz", + "integrity": "sha512-fHdvsTR1dHkWKev9eNyhTo4EFwbUvJ8ka9SgeWkMPYFX4WoI7ViVBms3PjlQYgw5TLvNQso3GUB/b/8t3yo+dg==", + "dependencies": { + "@types/mdast": "^4.0.2", + "emoticon": "^4.0.1", + "mdast-util-find-and-replace": "^3.0.1", + "node-emoji": "^2.1.0", + "unified": "^11.0.4" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + } + }, + "node_modules/remark-frontmatter": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-5.0.0.tgz", + "integrity": "sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-frontmatter": "^2.0.0", + "micromark-extension-frontmatter": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-gfm": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/remark-gfm/-/remark-gfm-4.0.0.tgz", + "integrity": "sha512-U92vJgBPkbw4Zfu/IiW2oTZLSL3Zpv+uI7My2eq8JxKgqraFdU8YUGicEJCEgSbeaG+QDFqIcwwfMTOEelPxuA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-gfm": "^3.0.0", + "micromark-extension-gfm": "^3.0.0", + "remark-parse": "^11.0.0", + "remark-stringify": "^11.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-mdx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/remark-mdx/-/remark-mdx-3.0.1.tgz", + "integrity": "sha512-3Pz3yPQ5Rht2pM5R+0J2MrGoBSrzf+tJG94N+t/ilfdh8YLyyKYtidAYwTveB20BoHAcwIopOUqhcmh2F7hGYA==", + "dependencies": { + "mdast-util-mdx": "^3.0.0", + "micromark-extension-mdxjs": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-parse": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-11.0.0.tgz", + "integrity": "sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-from-markdown": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-rehype": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/remark-rehype/-/remark-rehype-11.1.0.tgz", + "integrity": "sha512-z3tJrAs2kIs1AqIIy6pzHmAHlF1hWQ+OdY4/hv+Wxe35EhyLKcajL33iUEn3ScxtFox9nUvRufR/Zre8Q08H/g==", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "mdast-util-to-hast": "^13.0.0", + "unified": "^11.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/remark-stringify": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-11.0.0.tgz", + "integrity": "sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==", + "dependencies": { + "@types/mdast": "^4.0.0", + "mdast-util-to-markdown": "^2.0.0", + "unified": "^11.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/renderkid": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/renderkid/-/renderkid-3.0.0.tgz", + "integrity": "sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==", + "dependencies": { + "css-select": "^4.1.3", + "dom-converter": "^0.2.0", + "htmlparser2": "^6.1.0", + "lodash": "^4.17.21", + "strip-ansi": "^6.0.1" + } + }, + "node_modules/renderkid/node_modules/css-select": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", + "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.0.1", + "domhandler": "^4.3.1", + "domutils": "^2.8.0", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/renderkid/node_modules/dom-serializer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", + "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.2.0", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domhandler": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", + "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", + "dependencies": { + "domelementtype": "^2.2.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/domutils": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", + "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", + "dependencies": { + "dom-serializer": "^1.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.2.0" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/renderkid/node_modules/htmlparser2": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", + "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.0.0", + "domutils": "^2.5.2", + "entities": "^2.0.0" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-like": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/require-like/-/require-like-0.1.2.tgz", + "integrity": "sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==", + "engines": { + "node": "*" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==" + }, + "node_modules/resolve": { + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-alpn": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", + "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==" + }, + "node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "engines": { + "node": ">=4" + } + }, + "node_modules/resolve-pathname": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", + "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==" + }, + "node_modules/responselike": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/responselike/-/responselike-3.0.0.tgz", + "integrity": "sha512-40yHxbNcl2+rzXvZuVkrYohathsSJlMTXKryG5y8uciHv1+xDLHQpgjG64JUO9nrEq2jGLH6IZ8BcZyw3wrweg==", + "dependencies": { + "lowercase-keys": "^3.0.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/retry": { + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz", + "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==", + "engines": { + "node": ">= 4" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rtl-detect": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/rtl-detect/-/rtl-detect-1.1.2.tgz", + "integrity": "sha512-PGMBq03+TTG/p/cRB7HCLKJ1MgDIi07+QU1faSjiYRfmY5UsAttV9Hs08jDAHVwcOwmVLcSJkpwyfXszVjWfIQ==" + }, + "node_modules/rtlcss": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.1.1.tgz", + "integrity": "sha512-/oVHgBtnPNcggP2aVXQjSy6N1mMAfHg4GSag0QtZBlD5bdDgAHwr4pydqJGd+SUCu9260+Pjqbjwtvu7EMH1KQ==", + "dependencies": { + "escalade": "^3.1.1", + "picocolors": "^1.0.0", + "postcss": "^8.4.21", + "strip-json-comments": "^3.1.1" + }, + "bin": { + "rtlcss": "bin/rtlcss.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "node_modules/sax": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.1.tgz", + "integrity": "sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg==" + }, + "node_modules/scheduler": { + "version": "0.23.2", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", + "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", + "dependencies": { + "loose-envify": "^1.1.0" + } + }, + "node_modules/schema-utils": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.2.0.tgz", + "integrity": "sha512-L0jRsrPpjdckP3oPug3/VxNKt2trR8TcabrM6FOAAlvC/9Phcmm+cuAgTlxBqdBR1WJx7Naj9WHw+aOmheSVbw==", + "dependencies": { + "@types/json-schema": "^7.0.9", + "ajv": "^8.9.0", + "ajv-formats": "^2.1.1", + "ajv-keywords": "^5.1.0" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/search-insights": { + "version": "2.14.0", + "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.14.0.tgz", + "integrity": "sha512-OLN6MsPMCghDOqlCtsIsYgtsC0pnwVTyT9Mu6A3ewOj1DxvzZF6COrn2g86E/c05xbktB0XN04m/t1Z+n+fTGw==", + "peer": true + }, + "node_modules/section-matter": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", + "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", + "dependencies": { + "extend-shallow": "^2.0.1", + "kind-of": "^6.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/select-hose": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/select-hose/-/select-hose-2.0.0.tgz", + "integrity": "sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==" + }, + "node_modules/selfsigned": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/selfsigned/-/selfsigned-2.4.1.tgz", + "integrity": "sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q==", + "dependencies": { + "@types/node-forge": "^1.3.0", + "node-forge": "^1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver-diff": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", + "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/send": { + "version": "0.18.0", + "resolved": "https://registry.npmjs.org/send/-/send-0.18.0.tgz", + "integrity": "sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg==", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + }, + "node_modules/send/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serialize-javascript": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "dependencies": { + "randombytes": "^2.1.0" + } + }, + "node_modules/serve-handler": { + "version": "6.1.5", + "resolved": "https://registry.npmjs.org/serve-handler/-/serve-handler-6.1.5.tgz", + "integrity": "sha512-ijPFle6Hwe8zfmBxJdE+5fta53fdIY0lHISJvuikXB3VYFafRjMRpOffSPvCYsbKyBA7pvy9oYr/BT1O3EArlg==", + "dependencies": { + "bytes": "3.0.0", + "content-disposition": "0.5.2", + "fast-url-parser": "1.1.3", + "mime-types": "2.1.18", + "minimatch": "3.1.2", + "path-is-inside": "1.0.2", + "path-to-regexp": "2.2.1", + "range-parser": "1.2.0" + } + }, + "node_modules/serve-handler/node_modules/path-to-regexp": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-2.2.1.tgz", + "integrity": "sha512-gu9bD6Ta5bwGrrU8muHzVOBFFREpp2iRkVfhBJahwJ6p6Xw20SjT0MxLnwkjOibQmGSYhiUnf2FLe7k+jcFmGQ==" + }, + "node_modules/serve-index": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/serve-index/-/serve-index-1.9.1.tgz", + "integrity": "sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw==", + "dependencies": { + "accepts": "~1.3.4", + "batch": "0.6.1", + "debug": "2.6.9", + "escape-html": "~1.0.3", + "http-errors": "~1.6.2", + "mime-types": "~2.1.17", + "parseurl": "~1.3.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/serve-index/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/serve-index/node_modules/depd": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", + "integrity": "sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/http-errors": { + "version": "1.6.3", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.3.tgz", + "integrity": "sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==", + "dependencies": { + "depd": "~1.1.2", + "inherits": "2.0.3", + "setprototypeof": "1.1.0", + "statuses": ">= 1.4.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-index/node_modules/inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==" + }, + "node_modules/serve-index/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" + }, + "node_modules/serve-index/node_modules/setprototypeof": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.0.tgz", + "integrity": "sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==" + }, + "node_modules/serve-index/node_modules/statuses": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", + "integrity": "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/serve-static": { + "version": "1.15.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.15.0.tgz", + "integrity": "sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g==", + "dependencies": { + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.18.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==" + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shallowequal": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", + "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==" + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "engines": { + "node": ">=8" + } + }, + "node_modules/shell-quote": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.8.1.tgz", + "integrity": "sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/shelljs": { + "version": "0.8.5", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz", + "integrity": "sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==", + "dependencies": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + }, + "bin": { + "shjs": "bin/shjs" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/shiki": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.12.1.tgz", + "integrity": "sha512-nwmjbHKnOYYAe1aaQyEBHvQymJgfm86ZSS7fT8OaPRr4sbAcBNz7PbfAikMEFSDQ6se2j2zobkXvVKcBOm0ysg==", + "dev": true, + "dependencies": { + "@shikijs/core": "1.12.1", + "@types/hast": "^3.0.4" + } + }, + "node_modules/side-channel": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" + }, + "node_modules/sirv": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/sirv/-/sirv-2.0.4.tgz", + "integrity": "sha512-94Bdh3cC2PKrbgSOUqTiGPWVZeSiXfKOVZNJniWoqrWrRkB1CJzBU3NEbiTsPcYy1lDsANA/THzS+9WBiy5nfQ==", + "dependencies": { + "@polka/url": "^1.0.0-next.24", + "mrmime": "^2.0.0", + "totalist": "^3.0.0" + }, + "engines": { + "node": ">= 10" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==" + }, + "node_modules/sitemap": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/sitemap/-/sitemap-7.1.2.tgz", + "integrity": "sha512-ARCqzHJ0p4gWt+j7NlU5eDlIO9+Rkr/JhPFZKKQ1l5GCus7rJH4UdrlVAh0xC/gDS/Qir2UMxqYNHtsKr2rpCw==", + "dependencies": { + "@types/node": "^17.0.5", + "@types/sax": "^1.2.1", + "arg": "^5.0.0", + "sax": "^1.2.4" + }, + "bin": { + "sitemap": "dist/cli.js" + }, + "engines": { + "node": ">=12.0.0", + "npm": ">=5.6.0" + } + }, + "node_modules/sitemap/node_modules/@types/node": { + "version": "17.0.45", + "resolved": "https://registry.npmjs.org/@types/node/-/node-17.0.45.tgz", + "integrity": "sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==" + }, + "node_modules/skin-tone": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/skin-tone/-/skin-tone-2.0.0.tgz", + "integrity": "sha512-kUMbT1oBJCpgrnKoSr0o6wPtvRWT9W9UKvGLwfJYO2WuahZRHOpEyL1ckyMGgMWh0UdpmaoFqKKD29WTomNEGA==", + "dependencies": { + "unicode-emoji-modifier-base": "^1.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "engines": { + "node": ">=8" + } + }, + "node_modules/snake-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", + "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/sockjs": { + "version": "0.3.24", + "resolved": "https://registry.npmjs.org/sockjs/-/sockjs-0.3.24.tgz", + "integrity": "sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==", + "dependencies": { + "faye-websocket": "^0.11.3", + "uuid": "^8.3.2", + "websocket-driver": "^0.7.4" + } + }, + "node_modules/sort-css-media-queries": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz", + "integrity": "sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA==", + "engines": { + "node": ">= 6.3.0" + } + }, + "node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "engines": { + "node": ">= 8" + } + }, + "node_modules/source-map-js": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz", + "integrity": "sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/source-map-support/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/spdy": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/spdy/-/spdy-4.0.2.tgz", + "integrity": "sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==", + "dependencies": { + "debug": "^4.1.0", + "handle-thing": "^2.0.0", + "http-deceiver": "^1.2.7", + "select-hose": "^2.0.0", + "spdy-transport": "^3.0.0" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/spdy-transport": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/spdy-transport/-/spdy-transport-3.0.0.tgz", + "integrity": "sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==", + "dependencies": { + "debug": "^4.1.0", + "detect-node": "^2.0.4", + "hpack.js": "^2.1.6", + "obuf": "^1.1.2", + "readable-stream": "^3.0.6", + "wbuf": "^1.7.3" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==" + }, + "node_modules/srcset": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/srcset/-/srcset-4.0.0.tgz", + "integrity": "sha512-wvLeHgcVHKO8Sc/H/5lkGreJQVeYMm9rlmt8PuR1xE31rIuXhuzznUUqAt8MqLhB3MqJdFzlNAfpcWnxiFUcPw==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/std-env": { + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.7.0.tgz", + "integrity": "sha512-JPbdCEQLj1w5GilpiHAx3qJvFndqybBysA3qUOnznweH4QbNYUsW/ea8QzSrnh0vNsezMMw5bcVool8lM0gwzg==" + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", + "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/string-width/node_modules/ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/string-width/node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/stringify-object": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", + "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "dependencies": { + "get-own-enumerable-property-symbols": "^3.0.0", + "is-obj": "^1.0.1", + "is-regexp": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom-string": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/strip-bom-string/-/strip-bom-string-1.0.0.tgz", + "integrity": "sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/style-to-object": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/style-to-object/-/style-to-object-0.4.4.tgz", + "integrity": "sha512-HYNoHZa2GorYNyqiCaBgsxvcJIn7OHq6inEga+E6Ke3m5JkoqpQbnFssk4jwe+K7AhGa2fcha4wSOf1Kn01dMg==", + "dependencies": { + "inline-style-parser": "0.1.1" + } + }, + "node_modules/stylehacks": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/stylehacks/-/stylehacks-6.1.1.tgz", + "integrity": "sha512-gSTTEQ670cJNoaeIp9KX6lZmm8LJ3jPB5yJmX8Zq/wQxOsAFXV3qjWzHas3YYk1qesuVIyYWWUpZ0vSE/dTSGg==", + "dependencies": { + "browserslist": "^4.23.0", + "postcss-selector-parser": "^6.0.16" + }, + "engines": { + "node": "^14 || ^16 || >=18.0" + }, + "peerDependencies": { + "postcss": "^8.4.31" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/svg-parser": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/svg-parser/-/svg-parser-2.0.4.tgz", + "integrity": "sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==" + }, + "node_modules/svgo": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/svgo/-/svgo-3.3.2.tgz", + "integrity": "sha512-OoohrmuUlBs8B8o6MB2Aevn+pRIH9zDALSR+6hhqVfa6fRwG/Qw9VUMSMW9VNg2CFc/MTIfabtdOVl9ODIJjpw==", + "dependencies": { + "@trysound/sax": "0.2.0", + "commander": "^7.2.0", + "css-select": "^5.1.0", + "css-tree": "^2.3.1", + "css-what": "^6.1.0", + "csso": "^5.0.5", + "picocolors": "^1.0.0" + }, + "bin": { + "svgo": "bin/svgo" + }, + "engines": { + "node": ">=14.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/svgo" + } + }, + "node_modules/svgo/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "engines": { + "node": ">= 10" + } + }, + "node_modules/tapable": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", + "integrity": "sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==", + "engines": { + "node": ">=6" + } + }, + "node_modules/terser": { + "version": "5.31.1", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.31.1.tgz", + "integrity": "sha512-37upzU1+viGvuFtBo9NPufCb9dwM0+l9hMxYyWfBA+fbwrPqNJAhbZ6W47bBFnZHKHTUBnMvi87434qq+qnxOg==", + "dependencies": { + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.8.2", + "commander": "^2.20.0", + "source-map-support": "~0.5.20" + }, + "bin": { + "terser": "bin/terser" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/terser-webpack-plugin": { + "version": "5.3.10", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.10.tgz", + "integrity": "sha512-BKFPWlPDndPs+NGGCr1U59t0XScL5317Y0UReNrHaw9/FwhPENlq6bfgs+4yPfyP51vqC1bQ4rp1EfXW5ZSH9w==", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.20", + "jest-worker": "^27.4.5", + "schema-utils": "^3.1.1", + "serialize-javascript": "^6.0.1", + "terser": "^5.26.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "uglify-js": { + "optional": true + } + } + }, + "node_modules/terser-webpack-plugin/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/terser-webpack-plugin/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/terser-webpack-plugin/node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/terser-webpack-plugin/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/terser-webpack-plugin/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/terser-webpack-plugin/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/terser/node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==" + }, + "node_modules/thunky": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/thunky/-/thunky-1.1.0.tgz", + "integrity": "sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==" + }, + "node_modules/tiny-invariant": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", + "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==" + }, + "node_modules/tiny-warning": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", + "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==" + }, + "node_modules/to-fast-properties": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", + "integrity": "sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==", + "engines": { + "node": ">=4" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/totalist": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz", + "integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==", + "engines": { + "node": ">=6" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/trough": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/trough/-/trough-2.2.0.tgz", + "integrity": "sha512-tmMpK00BjZiUyVyvrBK7knerNgmgvcV/KLVyuma/SC+TQN167GrMRciANTz09+k3zW8L8t60jWO1GpfkZdjTaw==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tslib": { + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", + "integrity": "sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==" + }, + "node_modules/type-fest": { + "version": "2.19.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz", + "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/type-is/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typedoc": { + "version": "0.26.5", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.5.tgz", + "integrity": "sha512-Vn9YKdjKtDZqSk+by7beZ+xzkkr8T8CYoiasqyt4TTRFy5+UHzL/mF/o4wGBjRF+rlWQHDb0t6xCpA3JNL5phg==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "markdown-it": "^14.1.0", + "minimatch": "^9.0.5", + "shiki": "^1.9.1", + "yaml": "^2.4.5" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.2.3.tgz", + "integrity": "sha512-esucQj79SFYOv0f5XVha7QWdLUH5C5HRlDf7Z8CXzHedmVPn7jox6Gt7FdoBXN8AFxyHpa3Lbuxu65Dobwt+4Q==", + "dev": true, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.26.x" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/typedoc/node_modules/yaml": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.0.tgz", + "integrity": "sha512-2wWLbGbYDiSqqIKoPjar3MPgB94ErzCtrNE1FdqGuaO0pi2JGjmE8aW8TDZwzU7vuxcGRdL/4gPQwQ7hD5AMSw==", + "dev": true, + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, + "node_modules/typescript": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.3.tgz", + "integrity": "sha512-/hreyEujaB0w76zKo6717l3L0o/qEUtRgdvUBvlkhoWeOVMjMuHNHk0BRBzikzuGDqNmPQbg5ifMEqsHLiIUcQ==", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true + }, + "node_modules/undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==" + }, + "node_modules/unicode-canonical-property-names-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", + "integrity": "sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ==", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-emoji-modifier-base": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unicode-emoji-modifier-base/-/unicode-emoji-modifier-base-1.0.0.tgz", + "integrity": "sha512-yLSH4py7oFH3oG/9K+XWrz1pSi3dfUrWEnInbxMfArOfc1+33BlGPQtLsOYwvdMy11AwUBetYuaRxSPqgkq+8g==", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", + "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "dependencies": { + "unicode-canonical-property-names-ecmascript": "^2.0.0", + "unicode-property-aliases-ecmascript": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-value-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.1.0.tgz", + "integrity": "sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA==", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-property-aliases-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz", + "integrity": "sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==", + "engines": { + "node": ">=4" + } + }, + "node_modules/unified": { + "version": "11.0.5", + "resolved": "https://registry.npmjs.org/unified/-/unified-11.0.5.tgz", + "integrity": "sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==", + "dependencies": { + "@types/unist": "^3.0.0", + "bail": "^2.0.0", + "devlop": "^1.0.0", + "extend": "^3.0.0", + "is-plain-obj": "^4.0.0", + "trough": "^2.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unique-string": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", + "dependencies": { + "crypto-random-string": "^4.0.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz", + "integrity": "sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position-from-estree": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position-from-estree/-/unist-util-position-from-estree-2.0.0.tgz", + "integrity": "sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-remove-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-remove-position/-/unist-util-remove-position-5.0.0.tgz", + "integrity": "sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-visit": "^5.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.0.0.tgz", + "integrity": "sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", + "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", + "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "dependencies": { + "escalade": "^3.1.2", + "picocolors": "^1.0.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/update-notifier": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", + "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", + "dependencies": { + "boxen": "^7.0.0", + "chalk": "^5.0.1", + "configstore": "^6.0.0", + "has-yarn": "^3.0.0", + "import-lazy": "^4.0.0", + "is-ci": "^3.0.1", + "is-installed-globally": "^0.4.0", + "is-npm": "^6.0.0", + "is-yarn-global": "^0.4.0", + "latest-version": "^7.0.0", + "pupa": "^3.1.0", + "semver": "^7.3.7", + "semver-diff": "^4.0.0", + "xdg-basedir": "^5.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/yeoman/update-notifier?sponsor=1" + } + }, + "node_modules/update-notifier/node_modules/boxen": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.1.1.tgz", + "integrity": "sha512-2hCgjEmP8YLWQ130n2FerGv7rYpfBmnmp9Uy2Le1vge6X3gZIfSmEzP5QTDElFxcvVcXlEn8Aq6MU/PZygIOog==", + "dependencies": { + "ansi-align": "^3.0.1", + "camelcase": "^7.0.1", + "chalk": "^5.2.0", + "cli-boxes": "^3.0.0", + "string-width": "^5.1.2", + "type-fest": "^2.13.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.1.0" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/camelcase": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.1.tgz", + "integrity": "sha512-xlx1yCK2Oc1APsPXDL2LdlNP6+uu8OCDdhOBSVT279M/S+y75O30C2VuD8T2ogdePBBl7PfPF4504tnLgX3zfw==", + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/update-notifier/node_modules/chalk": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", + "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/uri-js/node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "engines": { + "node": ">=6" + } + }, + "node_modules/url-loader": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/url-loader/-/url-loader-4.1.1.tgz", + "integrity": "sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==", + "dependencies": { + "loader-utils": "^2.0.0", + "mime-types": "^2.1.27", + "schema-utils": "^3.0.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "file-loader": "*", + "webpack": "^4.0.0 || ^5.0.0" + }, + "peerDependenciesMeta": { + "file-loader": { + "optional": true + } + } + }, + "node_modules/url-loader/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/url-loader/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/url-loader/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/url-loader/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/url-loader/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==" + }, + "node_modules/utila": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/utila/-/utila-0.4.0.tgz", + "integrity": "sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==" + }, + "node_modules/utility-types": { + "version": "3.11.0", + "resolved": "https://registry.npmjs.org/utility-types/-/utility-types-3.11.0.tgz", + "integrity": "sha512-6Z7Ma2aVEWisaL6TvBCy7P8rm2LQoPv6dJ7ecIaIixHcwfbJ0x7mWdbcwlIM5IGQxPZSFYeqRCqlOOeKoJYMkw==", + "engines": { + "node": ">= 4" + } + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/uuid": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", + "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", + "bin": { + "uuid": "dist/bin/uuid" + } + }, + "node_modules/value-equal": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", + "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==" + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vfile": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.1.tgz", + "integrity": "sha512-1bYqc7pt6NIADBJ98UiG0Bn/CHIVOoZ/IyEkqIruLg0mE1BKzkOXY2D6CSqQIcKqgadppE5lrxgWXJmXd7zZJw==", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-location": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/vfile-location/-/vfile-location-5.0.2.tgz", + "integrity": "sha512-NXPYyxyBSH7zB5U6+3uDdd6Nybz6o6/od9rk8bp9H8GR3L+cm/fC0uUTbqBmUTnMCUDslAGBOIKNfvvb+gGlDg==", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.2.tgz", + "integrity": "sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/watchpack": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.4.1.tgz", + "integrity": "sha512-8wrBCMtVhqcXP2Sup1ctSkga6uc2Bx0IIvKyT7yTFier5AXHooSI+QyQQAtTb7+E0IUCCKyTFmXqdqgum2XWGg==", + "dependencies": { + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.1.2" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/wbuf": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/wbuf/-/wbuf-1.7.3.tgz", + "integrity": "sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==", + "dependencies": { + "minimalistic-assert": "^1.0.0" + } + }, + "node_modules/web-namespaces": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/web-namespaces/-/web-namespaces-2.0.1.tgz", + "integrity": "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/webpack": { + "version": "5.92.1", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.92.1.tgz", + "integrity": "sha512-JECQ7IwJb+7fgUFBlrJzbyu3GEuNBcdqr1LD7IbSzwkSmIevTm8PF+wej3Oxuz/JFBUZ6O1o43zsPkwm1C4TmA==", + "dependencies": { + "@types/eslint-scope": "^3.7.3", + "@types/estree": "^1.0.5", + "@webassemblyjs/ast": "^1.12.1", + "@webassemblyjs/wasm-edit": "^1.12.1", + "@webassemblyjs/wasm-parser": "^1.12.1", + "acorn": "^8.7.1", + "acorn-import-attributes": "^1.9.5", + "browserslist": "^4.21.10", + "chrome-trace-event": "^1.0.2", + "enhanced-resolve": "^5.17.0", + "es-module-lexer": "^1.2.1", + "eslint-scope": "5.1.1", + "events": "^3.2.0", + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.2.11", + "json-parse-even-better-errors": "^2.3.1", + "loader-runner": "^4.2.0", + "mime-types": "^2.1.27", + "neo-async": "^2.6.2", + "schema-utils": "^3.2.0", + "tapable": "^2.1.1", + "terser-webpack-plugin": "^5.3.10", + "watchpack": "^2.4.1", + "webpack-sources": "^3.2.3" + }, + "bin": { + "webpack": "bin/webpack.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependenciesMeta": { + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-bundle-analyzer": { + "version": "4.10.2", + "resolved": "https://registry.npmjs.org/webpack-bundle-analyzer/-/webpack-bundle-analyzer-4.10.2.tgz", + "integrity": "sha512-vJptkMm9pk5si4Bv922ZbKLV8UTT4zib4FPgXMhgzUny0bfDDkLXAVQs3ly3fS4/TN9ROFtb0NFrm04UXFE/Vw==", + "dependencies": { + "@discoveryjs/json-ext": "0.5.7", + "acorn": "^8.0.4", + "acorn-walk": "^8.0.0", + "commander": "^7.2.0", + "debounce": "^1.2.1", + "escape-string-regexp": "^4.0.0", + "gzip-size": "^6.0.0", + "html-escaper": "^2.0.2", + "opener": "^1.5.2", + "picocolors": "^1.0.0", + "sirv": "^2.0.3", + "ws": "^7.3.1" + }, + "bin": { + "webpack-bundle-analyzer": "lib/bin/analyzer.js" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/webpack-bundle-analyzer/node_modules/commander": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz", + "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", + "engines": { + "node": ">= 10" + } + }, + "node_modules/webpack-dev-middleware": { + "version": "5.3.4", + "resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-5.3.4.tgz", + "integrity": "sha512-BVdTqhhs+0IfoeAf7EoH5WE+exCmqGerHfDM0IL096Px60Tq2Mn9MAbnaGUe6HiMa41KMCYF19gyzZmBcq/o4Q==", + "dependencies": { + "colorette": "^2.0.10", + "memfs": "^3.4.3", + "mime-types": "^2.1.31", + "range-parser": "^1.2.1", + "schema-utils": "^4.0.0" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.0.0 || ^5.0.0" + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-middleware/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-middleware/node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack-dev-server": { + "version": "4.15.2", + "resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-4.15.2.tgz", + "integrity": "sha512-0XavAZbNJ5sDrCbkpWL8mia0o5WPOd2YGtxrEiZkBK9FjLppIUK2TgxK6qGD2P3hUXTJNNPVibrerKcx5WkR1g==", + "dependencies": { + "@types/bonjour": "^3.5.9", + "@types/connect-history-api-fallback": "^1.3.5", + "@types/express": "^4.17.13", + "@types/serve-index": "^1.9.1", + "@types/serve-static": "^1.13.10", + "@types/sockjs": "^0.3.33", + "@types/ws": "^8.5.5", + "ansi-html-community": "^0.0.8", + "bonjour-service": "^1.0.11", + "chokidar": "^3.5.3", + "colorette": "^2.0.10", + "compression": "^1.7.4", + "connect-history-api-fallback": "^2.0.0", + "default-gateway": "^6.0.3", + "express": "^4.17.3", + "graceful-fs": "^4.2.6", + "html-entities": "^2.3.2", + "http-proxy-middleware": "^2.0.3", + "ipaddr.js": "^2.0.1", + "launch-editor": "^2.6.0", + "open": "^8.0.9", + "p-retry": "^4.5.0", + "rimraf": "^3.0.2", + "schema-utils": "^4.0.0", + "selfsigned": "^2.1.1", + "serve-index": "^1.9.1", + "sockjs": "^0.3.24", + "spdy": "^4.0.2", + "webpack-dev-middleware": "^5.3.4", + "ws": "^8.13.0" + }, + "bin": { + "webpack-dev-server": "bin/webpack-dev-server.js" + }, + "engines": { + "node": ">= 12.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^4.37.0 || ^5.0.0" + }, + "peerDependenciesMeta": { + "webpack": { + "optional": true + }, + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-dev-server/node_modules/ws": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz", + "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==", + "engines": { + "node": ">=10.0.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": ">=5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/webpack-merge": { + "version": "5.10.0", + "resolved": "https://registry.npmjs.org/webpack-merge/-/webpack-merge-5.10.0.tgz", + "integrity": "sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==", + "dependencies": { + "clone-deep": "^4.0.1", + "flat": "^5.0.2", + "wildcard": "^2.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/webpack-sources": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.2.3.tgz", + "integrity": "sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w==", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/webpack/node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/webpack/node_modules/ajv-keywords": { + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-3.5.2.tgz", + "integrity": "sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==", + "peerDependencies": { + "ajv": "^6.9.1" + } + }, + "node_modules/webpack/node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/webpack/node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack/node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/webpack/node_modules/schema-utils": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-3.3.0.tgz", + "integrity": "sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==", + "dependencies": { + "@types/json-schema": "^7.0.8", + "ajv": "^6.12.5", + "ajv-keywords": "^3.5.2" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/webpackbar": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/webpackbar/-/webpackbar-5.0.2.tgz", + "integrity": "sha512-BmFJo7veBDgQzfWXl/wwYXr/VFus0614qZ8i9znqcl9fnEdiVkdbi0TedLQ6xAK92HZHDJ0QmyQ0fmuZPAgCYQ==", + "dependencies": { + "chalk": "^4.1.0", + "consola": "^2.15.3", + "pretty-time": "^1.1.0", + "std-env": "^3.0.1" + }, + "engines": { + "node": ">=12" + }, + "peerDependencies": { + "webpack": "3 || 4 || 5" + } + }, + "node_modules/websocket-driver": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/websocket-driver/-/websocket-driver-0.7.4.tgz", + "integrity": "sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==", + "dependencies": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/websocket-extensions": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz", + "integrity": "sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/widest-line": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", + "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", + "dependencies": { + "string-width": "^5.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wildcard": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/wildcard/-/wildcard-2.0.1.tgz", + "integrity": "sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==" + }, + "node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi/node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.10", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.10.tgz", + "integrity": "sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ==", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/xdg-basedir": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/xml-js": { + "version": "1.6.11", + "resolved": "https://registry.npmjs.org/xml-js/-/xml-js-1.6.11.tgz", + "integrity": "sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==", + "dependencies": { + "sax": "^1.2.4" + }, + "bin": { + "xml-js": "bin/cli.js" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==" + }, + "node_modules/yaml": { + "version": "1.10.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", + "integrity": "sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==", + "engines": { + "node": ">= 6" + } + }, + "node_modules/yocto-queue": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", + "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + } + } +} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 000000000..c0bbbf235 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,50 @@ +{ + "name": "website", + "version": "2024.08.01", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids" + }, + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/plugin-client-redirects": "^3.4.0", + "@docusaurus/preset-classic": "3.4.0", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "docusaurus-theme-github-codeblock": "^2.0.2", + "prism-react-renderer": "^2.3.0", + "react": "^18.0.0", + "react-dom": "^18.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.4.0", + "@docusaurus/types": "3.4.0", + "@tsconfig/recommended": "^1.0.7", + "docusaurus-plugin-typedoc": "^1.0.4", + "typedoc": "^0.26.5", + "typedoc-plugin-markdown": "^4.2.3" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=20.0" + } +} diff --git a/docs/scripts/auto_anchor.js b/docs/scripts/auto_anchor.js deleted file mode 100644 index 1cc747021..000000000 --- a/docs/scripts/auto_anchor.js +++ /dev/null @@ -1,45 +0,0 @@ -var toggleVisibilityClass = 'invisible_until_anchor'; -var hTags = ['h1', 'h2', 'h3', 'h4', 'h5']; -var headerWithIdSelector = hTags.map(function (t) { return '.auto_anchor_container ' + t + '[id]' }).join(', '); - -window.addEventListener('DOMContentLoaded', (event) => { - // Find all elements whose visibility should be toggled when anchor elements are loaded - var toggleVisibilityEls = document.querySelectorAll('.' + toggleVisibilityClass); - - // Find the template element - var templateEl = document.querySelector('.anchor_template'); - if (!templateEl) { return; } - var newElementContainer = templateEl.parentElement; - - function createTemplatedElement(title, href, strong) { - var el = templateEl.cloneNode(true); - var anchor = el.querySelector('a'); - anchor.setAttribute('href', href); - - if (strong) { - var strongEl = document.createElement('strong'); - anchor.appendChild(strongEl); - strongEl.innerText = title; - } else { - anchor.innerText = title; - } - - return el; - } - - // Search for headers with anchors, and create a clone of the template for each header in the document - var headers = document.querySelectorAll(headerWithIdSelector) - Array.prototype.map.call(headers, function (header) { - return createTemplatedElement(header.innerText, '#' + header.id, header.classList.contains('auto-anchor-strong')); - }).forEach(function (newElement) { - newElementContainer.insertBefore(newElement, templateEl); - }); - - // Remove the template - newElementContainer.removeChild(templateEl); - - // Toggle visibility - toggleVisibilityEls.forEach(function (tEl) { - tEl.classList.remove(toggleVisibilityClass); - }); -}); diff --git a/docs/sidebars.js b/docs/sidebars.js new file mode 100644 index 000000000..823c3de74 --- /dev/null +++ b/docs/sidebars.js @@ -0,0 +1,160 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + + // But you can create a sidebar manually + sidebarNode: [ + { + type: 'doc', + id: 'index', // document ID + label: 'Node Slack SDK', // sidebar label + className: 'sidebar-title', + }, + 'getting-started', + 'typescript', + 'packages/web-api', + 'packages/oauth', + 'packages/rtm-api', + 'packages/webhook', + 'packages/socket-mode', + { + type: 'category', + label: 'Deprecated packages', + items: [ + 'packages/events-api', + 'packages/interactive-messages', + ], + }, + {type: 'html', value: '


'}, + { + type: 'category', + label: 'Tutorials', + items: [ + 'tutorials/local-development', + 'tutorials/migrating-to-v5', + 'tutorials/migrating-to-v6', + ], + }, + {type: 'html', value: '
'}, + { + type: 'category', + label: 'Reference', + items: [ + { + type: 'category', + label: '@slack/events-api', + link: { + type: 'doc', + id: 'reference/events-api/index', + }, + items: require('./content/reference/events-api/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/interactive-messages', + link: { + type: 'doc', + id: 'reference/interactive-messages/index', + }, + items: require('./content/reference/interactive-messages/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/logger', + link: { + type: 'doc', + id: 'reference/logger/index', + }, + items: require('./content/reference/logger/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/oauth', + link: { + type: 'doc', + id: 'reference/oauth/index', + }, + items: require('./content/reference/oauth/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/rtm-api', + link: { + type: 'doc', + id: 'reference/rtm-api/index', + }, + items: require('./content/reference/rtm-api/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/socket-mode', + link: { + type: 'doc', + id: 'reference/socket-mode/index', + }, + items: require('./content/reference/socket-mode/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/types', + link: { + type: 'doc', + id: 'reference/types/index', + }, + items: require('./content/reference/types/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/web-api', + link: { + type: 'doc', + id: 'reference/web-api/index', + }, + items: require('./content/reference/web-api/typedoc-sidebar.cjs'), + }, + { + type: 'category', + label: '@slack/webhook', + link: { + type: 'doc', + id: 'reference/webhook/index', + }, + items: require('./content/reference/webhook/typedoc-sidebar.cjs'), + }, + ], + }, + {type: 'html', value: '
'}, + { + type: 'link', + label: 'Release notes', + href: 'https://github.com/SlackAPI/node-slack-sdk/releases', + }, + { + type: 'link', + label: 'Code on GitHub', + href: 'https://github.com/SlackAPI/node-slack-sdk', + }, + { + type: 'link', + label: 'Contributors Guide', + href: 'https://github.com/SlackAPI/node-slack-sdk/blob/main/.github/contributing.md', + }, + + ], +}; + +export default sidebars; diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css new file mode 100644 index 000000000..cb5aecb9d --- /dev/null +++ b/docs/src/css/custom.css @@ -0,0 +1,113 @@ +/** + * Any CSS included here will be global. The classic template + * bundles Infima by default. Infima is a CSS framework designed to + * work well for content-centric websites. + */ + + :root { + /* set hex colors here pls */ + --aubergine: #4a154b; + + /* aubergine-active is used in light mode. + use something like #853c8c if you use as a link vs black text ( 3:1 contr) */ + --aubergine-active: #7c3085; + + /* aubergine-light is used in dark mode. #b681b5 is another one. i just made both up */ + --aubergine-light: #ce70cc; + + /* horchata is that beige color we use a lot */ + --horchata: #f4ede4; + + /* slack-blue is 36C5F0. used for dark-mode links */ + --slack-link: #36c5f0; + --slack-blue: #36c5f0; + /* slack marketing color for links 1264A3. used for light-mode links */ + --slack-dark-blue: #1264a3; + + --grey: #868686; + --white: #FFFFFF; +} + +/* resets striped tables that hurt me eyes */ +table tr:nth-child(even) { + background-color: inherit; +} + +p a { + text-decoration: underline; +} + +.markdown a { + color: var(--slack-link); + text-decoration: underline; +} + +/* adjusting for light and dark modes */ +[data-theme="light"] { + --ifm-color-primary: var(--aubergine-active); + --ifm-footer-background-color: var(--horchata); + --slack-link: var(--slack-dark-blue) +} + +[data-theme="dark"] { + --ifm-color-primary: var(--aubergine-light); + --ifm-navbar-background-color: var(--aubergine); + --ifm-footer-background-color: var(--aubergine); + --slack-link: var(--slack-blue) +} + +html[data-theme="dark"] { + --docusaurus-highlighted-code-line-bg: rgb(0 0 0 / 30%); +} + +/* bolding Toc for contrast */ +.table-of-contents__link--active { + font-weight: bold; +} + +/* only uncomment for home page -- colors white space on v tall screens */ +/* .main-wrapper { + background: var(--horchata); +} */ + +/* announcement bar up top */ +div[class^="announcementBar_"] { + font-size: 20px; + height: 50px; + background: var(--horchata); +} + +/* navbar */ + +.navbar-github-link { + width: 32px; + height: 32px; + padding: 6px; + margin-right: 6px; + margin-left: 6px; + border-radius: 50%; + transition: background var(--ifm-transition-fast); +} + +.navbar-github-link:hover { + background: var(--ifm-color-emphasis-200); +} + +.navbar-github-link::before { + content: ""; + height: 100%; + display: block; + background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") + no-repeat; +} + +html[data-theme="dark"] .navbar-github-link::before { + background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") + no-repeat; +} + +.sidebar-title { + font-size: 1.25em; /* Adjust the size as needed */ + font-weight: bold; + color: #000; +} \ No newline at end of file diff --git a/docs/src/theme/NotFound/Content/index.js b/docs/src/theme/NotFound/Content/index.js new file mode 100644 index 000000000..c122bc039 --- /dev/null +++ b/docs/src/theme/NotFound/Content/index.js @@ -0,0 +1,36 @@ +import React from 'react'; +import clsx from 'clsx'; +import Translate from '@docusaurus/Translate'; +import Heading from '@theme/Heading'; +export default function NotFoundContent({className}) { + return ( +
+
+
+ + + Oh no! There's nothing here. + + +

+ + If we've led you astray, please let us know. We'll do our best to get things in order. + + +

+

+ + For now, we suggest heading back to the beginning to get your bearings. May your next journey have clear skies to guide you true. + +

+
+
+
+ ); +} diff --git a/docs/src/theme/NotFound/index.js b/docs/src/theme/NotFound/index.js new file mode 100644 index 000000000..3b551f9e4 --- /dev/null +++ b/docs/src/theme/NotFound/index.js @@ -0,0 +1,19 @@ +import React from 'react'; +import {translate} from '@docusaurus/Translate'; +import {PageMetadata} from '@docusaurus/theme-common'; +import Layout from '@theme/Layout'; +import NotFoundContent from '@theme/NotFound/Content'; +export default function Index() { + const title = translate({ + id: 'theme.NotFound.title', + message: 'Page Not Found', + }); + return ( + <> + + + + + + ); +} diff --git a/docs/_reference/.gitkeep b/docs/static/.nojekyll similarity index 100% rename from docs/_reference/.gitkeep rename to docs/static/.nojekyll diff --git a/docs/static/img/bolt-js-logo.svg b/docs/static/img/bolt-js-logo.svg new file mode 100644 index 000000000..c14f317d5 --- /dev/null +++ b/docs/static/img/bolt-js-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/bolt-logo.svg b/docs/static/img/bolt-logo.svg new file mode 100644 index 000000000..5077600d5 --- /dev/null +++ b/docs/static/img/bolt-logo.svg @@ -0,0 +1 @@ + diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico new file mode 100644 index 000000000..e6e9a4aa7 Binary files /dev/null and b/docs/static/img/favicon.ico differ diff --git a/docs/static/img/slack-logo.svg b/docs/static/img/slack-logo.svg new file mode 100644 index 000000000..fb55f7245 --- /dev/null +++ b/docs/static/img/slack-logo.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/static/img/slack_logo_dark.svg b/docs/static/img/slack_logo_dark.svg new file mode 100644 index 000000000..464e9513c --- /dev/null +++ b/docs/static/img/slack_logo_dark.svg @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/static/img/style.css b/docs/static/img/style.css new file mode 100644 index 000000000..9a38809d3 --- /dev/null +++ b/docs/static/img/style.css @@ -0,0 +1,493 @@ +/* Color variables */ +:root { + --light-grey: #F8F8F8; + --grey: #868686; + --dark-grey: #616061; + --soft-grey: #ECECEC; + --blue: #1264A3; + --green: #00B073; + --light-blue: #B8D1E3; + --white: #FFFFFF; + --black: #1D1C1D; + --yellowish: #FF9E00; +} + +body { + background-color: var(--white); + font-family: 'Noto Sans JP', 'Slack-Lato', sans-serif; +} + +.content { + grid-area: content; +} + +/* Sidebar */ +.panel { + position: fixed; + width: 20%; + height: 100%; + overflow: auto; + top: 0; + left: 0; + background-color: var(--light-grey); +} + +.panel .sidebar-content { + width: 75%; + margin: 30px auto 20px auto; +} + +.panel .sidebar-content .logo { + padding-top: 1em; + position: relative; +} + +.panel .sidebar-content .logo .icon img { + width: 30px; + margin-right: 6px; +} + +.panel .sidebar-content .logo .name { + font-weight: 800; + font-size: 1.7em; + vertical-align: bottom; +} + +.panel .sidebar-content .logo .version { + line-height: 1em; + vertical-align: bottom; +} + +.panel .sidebar-content .logo .version a { + color: var(--dark-grey); + background-color: var(--soft-grey); + font-size: 0.5em; + font-weight: 800; + padding: 4px 10px; + border-radius: 12px; + margin-left: 10px; + +} + +.panel .sidebar-content ul.sidebar-section { + list-style: none; + list-style-position: inside; + padding-top: 0.9em; + margin: 0 0 0 -8px; + font-size: 0.80em; +} + +.panel .sidebar-content ul.sidebar-section li { + border-radius: 8px; + padding: 2px 0 2px 8px; + margin: 3px 0; + color: var(--black); +} + +.panel .sidebar-content ul.sidebar-section li:hover { + background-color: #D7D7D7; +} + +.panel .sidebar-content ul.sidebar-section li.madeby:hover { + background-color: transparent; +} + +.panel .sidebar-content a:hover { + text-decoration: none; +} + +.panel .sidebar-content ul.sidebar-section li.active { + background-color: var(--blue); + color: var(--white); +} + +.panel .sidebar-content ul.sidebar-section li.title { + font-weight: 600; +} + +.panel .sidebar-content ul.sidebar-section .label-warning { + line-height: 1em; + vertical-align: middle; + color: var(--white); + background-color: var(--dark-grey); + font-size: 0.5em; + font-weight: 800; + padding: 4px 10px; + border-radius: 12px; +} + +/* Main page */ +.header { + width: 95%; + margin: 0 auto 1em auto; + height: 5rem; + padding-top: 1.5em; +} + +.header a:hover { + text-decoration: none; +} + +.header a.language-switcher { + color: var(--grey); + font-weight: 700; + padding: 6px 14px 9px; + font-size: 15px; +} + +.header a.language-switcher:hover { + color: var(--black); +} + +.wrapper { + width: 100%; + margin: 0 auto; +} + +/* Main page content */ +.section-wrapper { + width: 90%; + margin: 0 auto 30px auto; + display: grid; + grid-gap: 25px; + grid-template-areas: + "head" + "body" + "code" + "secondary" + "divider" +} + +.tutorial-nav { + width: 20%; + position: fixed; +} + +.tutorial-nav ul { + margin-left: 3em; + padding-left: 1em; + border-width: 4px; + border-left-style: solid; + border-color: #F2F2F2; + border-image: linear-gradient( + to bottom, + #FFFFFF 0%, + #F2F2F2 6% 92%, + #FFFFFF 100% + ) 1 100%; + list-style: none; + padding-top: 1.5em; +} + +.circle { + background: #ddd; + border-radius: 50%; + height: 1em; + width: 1em; + float: left; + margin: 5px 0 0 -1.6em; +} + +.completed { + background: #58AF7F; +} + +.tutorial-nav ul li { + padding-bottom: 2.5em; +} + +.tutorial-nav a { + font-weight: 700; + font-size: 0.8em; + color: #757575; +} + +.tutorial-nav a:hover { + color: #000; + text-decoration: none; +} + +.tutorial { + width: 55%; + margin: 1em 0 0 33%; + padding-bottom: 2em; + font-size: 1em; + line-height: 1.75em; +} + +.tutorial img, .reference img { + width: 85%; + margin: 0.2em auto; + display: block; + box-shadow: 0 0 15px #DDDDDD; +} + +.tutorial blockquote, .reference blockquote { + margin: 0 0 0 1em; + padding: 0 6em 0 1.5em; + border-radius: 6px; + border-left: 6px solid #DDD; + font-size: 0.95em; +} + +.tutorial h3 { + padding-bottom: 1em; +} + +.label-warning { + line-height: 1em; + vertical-align: middle; + color: var(--white); + background-color: var(--dark-grey); + font-size: 0.45em; + font-weight: 800; + padding: 4px 10px; + border-radius: 12px; + margin-left: 10px; +} + +.reference { + width: 80%; + margin: 1em auto 3em auto; + padding-bottom: 2em; + font-size: 1em; + line-height: 1.75em; +} + +.reference h3 { + padding-top: 1em; +} + +.content .section-wrapper .language-javascript { + grid-area: code; +} + +pre { + background-color: var(--light-grey) !important; + background-image: none; + padding: 1em 1.5em; + border: 1px solid var(--soft-grey); + margin: 0; + border-radius: 1em; +} + +/* Code block with column numbers */ +pre.highlight { + line-height: 2em; + overflow-x: auto; +} + +pre.highlight code span { + padding: 0; + margin: 0; + height: 0; +} + +pre.highlight code pre { + padding: 0; + border: 0; + font-size: 0.9em; + overflow: visible; +} + +table.rouge-table, td.rouge-code, td.rouge-gutter { + padding: 0; + border: 0; + margin: 0; +} + +td.rouge-gutter { + padding-right: 1em; + user-select: none; + color: var(--dark-grey); +} +/* End Code block with column numbers */ + +.content .section-wrapper .section-content { + grid-area: body; + font-size: 1em; + line-height: 2em; +} + +.content .section-wrapper h3 { + grid-area: head; + font-size: 1.4em; + font-weight: 600; +} + +.content .section-wrapper hr { + grid-area: divider; + height: 1px; + border-top: 1px solid #DDD; + width: 100%; +} + +.content .section-wrapper .label-legacy { + line-height: 1em; + vertical-align: middle; + color: var(--white); + background-color: var(--dark-grey); + font-size: 0.5em; + font-weight: 800; + padding: 4px 10px; + border-radius: 12px; + margin-left: 10px; +} + + +a:hover { + text-decoration: underline; +} + +/* Secondary content */ +.secondary-wrapper { + width: 100%; + grid-area: secondary; + margin: 1em auto 0 auto; + font-size: 1em; + line-height: 1.75em; +} + +.secondary-wrapper .language-javascript { + width: 50%; + float: left; + margin-top: 1em; +} + +.content .section-wrapper .secondary-content { + width: 45%; + float: left; + margin-right: 5%; + margin-top: 1em; +} + +summary h4 { + display: inline; +} + +/* Responsive */ +@media (min-width: 1024px) { + .tutorial-nav ul { + margin-left: 5em; + } +} + +@media (min-width: 768px) { + .wrapper { + display: grid; + grid-template-columns: 20% 75%; + grid-template-areas: + "sidebar content" + } + + .section-wrapper { + grid-template-columns: 50% 50%; + grid-template-areas: + "head head" + "body code" + "secondary secondary" + "divider divider" + } +} + +@media (max-width: 768px) { + .panel { + display: none; + } + + .language-switcher { + display: none; + } + + .tutorial-nav { + display: none; + } + + .tutorial { + width: 85%; + margin: 1em auto; + } + + .wrapper { + display: grid; + grid-template-columns: 100%; + grid-template-areas: + "content" + } + + .section-wrapper { + grid-template-columns: 100%; + grid-template-areas: + "head" + "body" + "code" + "secondary" + "divider" + } +} + + +/* + * GitHub theme stylesheet from: http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html + */ + .highlight .hll { background-color: #ffffcc } + .highlight .c { color: #999988; } /* Comment */ + .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ + .highlight .k { color: #000000; font-weight: bold } /* Keyword */ + .highlight .o { color: #000000; font-weight: bold } /* Operator */ + .highlight .cm { color: #999988; } /* Comment.Multiline */ + .highlight .cp { color: #999999; font-weight: bold; } /* Comment.Preproc */ + .highlight .c1 { color: #999988; } /* Comment.Single */ + .highlight .cs { color: #999999; font-weight: bold; } /* Comment.Special */ + .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ + .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ + .highlight .gr { color: #aa0000 } /* Generic.Error */ + .highlight .gh { color: #999999 } /* Generic.Heading */ + .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ + .highlight .go { color: #888888 } /* Generic.Output */ + .highlight .gp { color: #555555 } /* Generic.Prompt */ + .highlight .gs { font-weight: bold } /* Generic.Strong */ + .highlight .gu { color: #aaaaaa } /* Generic.Subheading */ + .highlight .gt { color: #aa0000 } /* Generic.Traceback */ + .highlight .kc { color: #000000; font-weight: bold } /* Keyword.Constant */ + .highlight .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */ + .highlight .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */ + .highlight .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */ + .highlight .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */ + .highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ + .highlight .m { color: #009999 } /* Literal.Number */ + .highlight .s { color: #d01040 } /* Literal.String */ + .highlight .na { color: #008080 } /* Name.Attribute */ + .highlight .nb { color: #0086B3 } /* Name.Builtin */ + .highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ + .highlight .no { color: #008080 } /* Name.Constant */ + .highlight .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */ + .highlight .ni { color: #800080 } /* Name.Entity */ + .highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ + .highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ + .highlight .nl { color: #990000; font-weight: bold } /* Name.Label */ + .highlight .nn { color: #555555 } /* Name.Namespace */ + .highlight .nt { color: #000080 } /* Name.Tag */ + .highlight .nv { color: #008080 } /* Name.Variable */ + .highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */ + .highlight .w { color: #bbbbbb } /* Text.Whitespace */ + .highlight .mf { color: #009999 } /* Literal.Number.Float */ + .highlight .mh { color: #009999 } /* Literal.Number.Hex */ + .highlight .mi { color: #009999 } /* Literal.Number.Integer */ + .highlight .mo { color: #009999 } /* Literal.Number.Oct */ + .highlight .sb { color: #d01040 } /* Literal.String.Backtick */ + .highlight .sc { color: #d01040 } /* Literal.String.Char */ + .highlight .sd { color: #d01040 } /* Literal.String.Doc */ + .highlight .s2 { color: #d01040 } /* Literal.String.Double */ + .highlight .se { color: #d01040 } /* Literal.String.Escape */ + .highlight .sh { color: #d01040 } /* Literal.String.Heredoc */ + .highlight .si { color: #d01040 } /* Literal.String.Interpol */ + .highlight .sx { color: #d01040 } /* Literal.String.Other */ + .highlight .sr { color: #009926 } /* Literal.String.Regex */ + .highlight .s1 { color: #d01040 } /* Literal.String.Single */ + .highlight .ss { color: #990073 } /* Literal.String.Symbol */ + .highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ + .highlight .vc { color: #008080 } /* Name.Variable.Class */ + .highlight .vg { color: #008080 } /* Name.Variable.Global */ + .highlight .vi { color: #008080 } /* Name.Variable.Instance */ + .highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ diff --git a/docs/styles/docs.css b/docs/styles/docs.css deleted file mode 100644 index f8106b5c4..000000000 --- a/docs/styles/docs.css +++ /dev/null @@ -1,147 +0,0 @@ -/* Updates body font */ -body { - font-family: Slack-Lato,appleLogo,sans-serif; -} - -/* - * Unfix the header position. Otherwise, anchor links take you to a spot on the page that's covered. - * The API site fixes this by offsetting anchor tags from the headers in a weird and also error-prone way. - * It's a better tradeoff to unfix the header, and the side benefit is we get some screen space back. - */ -body > header { - position: initial; -} -@media only screen and (min-width: 641px) { - .api #page_contents { - padding-top: 2rem; - padding-bottom: 2rem; - } -} -@media only screen and (max-width: 640px) { - #page_contents { - margin-top: 0; - } -} - -/* Aligns footer navigation to the left of the sidebar */ -.footer_nav { - margin: 0 !important; -} - -/* Styles the signature all nice and pretty <3 */ -#footer_signature { - color:#e01e5a; - font-size:.9rem; - margin-top: 10px; -} - -/* Fixes link hover state */ -.card a:hover { - text-decoration: underline; -} - -/* Makes footer consistent */ -footer { - background-color: transparent; - border: 0; -} - -/* On the changelog, the release note headers should not be larger than the surrounding page header or version name */ -.release_notes h1, -.release_notes h2, -.release_notes h3 { - font-size:1.5rem; - line-height:1.75rem; -} - -/* Home button in sidebar on package pages */ -.nav_home { - margin:0; - font-weight: 600; - font-size: 1.1rem; -} -.nav_home_icon { - vertical-align: middle; -} - -/* Automatically rendered anchors */ -.invisible_until_anchor { - visibility: hidden; -} - -/* Details tags aren't styled in the rollup, but need the same margin bottom as paragraphs */ -details { - margin-bottom: 1rem; -} -summary > strong > i { - font-style: normal; -} - -/* - * ☁️ Maybe one day, #page_contents will be able to go beyond a fixed width... - */ - -/* - * Github theme stylesheet from: http://jwarby.github.io/jekyll-pygments-themes/languages/javascript.html - */ -.highlight .hll { background-color: #ffffcc } -.highlight .c { color: #999988; font-style: italic } /* Comment */ -.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -.highlight .k { color: #000000; font-weight: bold } /* Keyword */ -.highlight .o { color: #000000; font-weight: bold } /* Operator */ -.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */ -.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #aa0000 } /* Generic.Error */ -.highlight .gh { color: #999999 } /* Generic.Heading */ -.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ -.highlight .go { color: #888888 } /* Generic.Output */ -.highlight .gp { color: #555555 } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #aaaaaa } /* Generic.Subheading */ -.highlight .gt { color: #aa0000 } /* Generic.Traceback */ -.highlight .kc { color: #000000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ -.highlight .m { color: #009999 } /* Literal.Number */ -.highlight .s { color: #d01040 } /* Literal.String */ -.highlight .na { color: #008080 } /* Name.Attribute */ -.highlight .nb { color: #0086B3 } /* Name.Builtin */ -.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ -.highlight .no { color: #008080 } /* Name.Constant */ -.highlight .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #800080 } /* Name.Entity */ -.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ -.highlight .nl { color: #990000; font-weight: bold } /* Name.Label */ -.highlight .nn { color: #555555 } /* Name.Namespace */ -.highlight .nt { color: #000080 } /* Name.Tag */ -.highlight .nv { color: #008080 } /* Name.Variable */ -.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mf { color: #009999 } /* Literal.Number.Float */ -.highlight .mh { color: #009999 } /* Literal.Number.Hex */ -.highlight .mi { color: #009999 } /* Literal.Number.Integer */ -.highlight .mo { color: #009999 } /* Literal.Number.Oct */ -.highlight .sb { color: #d01040 } /* Literal.String.Backtick */ -.highlight .sc { color: #d01040 } /* Literal.String.Char */ -.highlight .sd { color: #d01040 } /* Literal.String.Doc */ -.highlight .s2 { color: #d01040 } /* Literal.String.Double */ -.highlight .se { color: #d01040 } /* Literal.String.Escape */ -.highlight .sh { color: #d01040 } /* Literal.String.Heredoc */ -.highlight .si { color: #d01040 } /* Literal.String.Interpol */ -.highlight .sx { color: #d01040 } /* Literal.String.Other */ -.highlight .sr { color: #009926 } /* Literal.String.Regex */ -.highlight .s1 { color: #d01040 } /* Literal.String.Single */ -.highlight .ss { color: #990073 } /* Literal.String.Symbol */ -.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #008080 } /* Name.Variable.Class */ -.highlight .vg { color: #008080 } /* Name.Variable.Global */ -.highlight .vi { color: #008080 } /* Name.Variable.Instance */ -.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ diff --git a/docs/typedoc.json b/docs/typedoc.json new file mode 100644 index 000000000..9f9329bef --- /dev/null +++ b/docs/typedoc.json @@ -0,0 +1,7 @@ +{ +"skipErrorChecking": true, +"useCodeBlocks": true, +"logLevel": "Error", +"readme": "none", +"gitRevision": "main" +} \ No newline at end of file