"use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __exportStar = (this && this.__exportStar) || function(m, exports) { for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); }; Object.defineProperty(exports, "__esModule", { value: true }); exports.Methods = void 0; const eventemitter3_1 = require("eventemitter3"); const WebClient_1 = require("./WebClient"); /** * Binds a certain `method` and its (required) arguments and result types to the `apiCall` method in `WebClient`. */ function bindApiCall(self, method) { const apiMethod = self.apiCall.bind(self, method); return apiMethod; } /** * Binds a certain `method` and its (required) arguments and result types to the `apiCall` method in `WebClient`. */ function bindApiCallWithOptionalArgument(self, method) { const apiMethod = self.apiCall.bind(self, method); return apiMethod; } function bindFilesUploadV2(self) { return self.filesUploadV2.bind(self); } /** * A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the * `apiCall` class method. */ class Methods extends eventemitter3_1.EventEmitter { constructor() { super(); this.admin = { analytics: { /** * @description Retrieve analytics data for a given date, presented as a compressed JSON file. * @see {@link https://docs.slack.dev/reference/methods/api.test `api.test` API reference}. */ getFile: bindApiCall(this, 'admin.analytics.getFile'), }, apps: { activities: { /** * @description Get logs for a specified team/org. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.activities.list `admin.apps.activities.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.apps.activities.list'), }, /** * @description Approve an app for installation on a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.approve `admin.apps.approve` API reference}. */ approve: bindApiCall(this, 'admin.apps.approve'), approved: { /** * @description List approved apps for an org or workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.approved.list `admin.apps.approved.list` API reference}. */ list: bindApiCall(this, 'admin.apps.approved.list'), }, /** * @description Clear an app resolution. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.clearResolution `admin.apps.clearResolution` API reference}. */ clearResolution: bindApiCall(this, 'admin.apps.clearResolution'), config: { /** * @description Look up the app config for connectors by their IDs. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.config.lookup `admin.apps.config.lookup` API reference}. */ lookup: bindApiCall(this, 'admin.apps.config.lookup'), /** * @description Set the app config for a connector. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.config.set `admin.apps.config.set` API reference}. */ set: bindApiCall(this, 'admin.apps.config.set'), }, requests: { /** * @description Cancel app request for team. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.requests.cancel `admin.apps.requests.cancel` API reference}. */ cancel: bindApiCall(this, 'admin.apps.requests.cancel'), /** * @description List app requests for a team/workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.requests.list `admin.apps.requests.list` API reference}. */ list: bindApiCall(this, 'admin.apps.requests.list'), }, /** * @description Restrict an app for installation on a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.restrict `admin.apps.restrict` API reference}. */ restrict: bindApiCall(this, 'admin.apps.restrict'), restricted: { /** * @description List restricted apps for an org or workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.restricted.list `admin.apps.restricted.list` API reference}. */ list: bindApiCall(this, 'admin.apps.restricted.list'), }, /** * @description Uninstall an app from one or many workspaces, or an entire enterprise organization. * @see {@link https://docs.slack.dev/reference/methods/admin.apps.uninstall `admin.apps.uninstall` API reference}. */ uninstall: bindApiCall(this, 'admin.apps.uninstall'), }, auth: { policy: { /** * @description Assign entities to a particular authentication policy. * @see {@link https://docs.slack.dev/reference/methods/admin.auth.policy.assignEntities `admin.auth.policy.assignEntities` API reference}. */ assignEntities: bindApiCall(this, 'admin.auth.policy.assignEntities'), /** * @description Fetch all the entities assigned to a particular authentication policy by name. * @see {@link https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities `admin.auth.policy.getEntities` API reference}. */ getEntities: bindApiCall(this, 'admin.auth.policy.getEntities'), /** * @description Remove specified entities from a specified authentication policy. * @see {@link https://docs.slack.dev/reference/methods/admin.auth.policy.removeEntities `admin.auth.policy.removeEntities` API reference}. */ removeEntities: bindApiCall(this, 'admin.auth.policy.removeEntities'), }, }, barriers: { /** * @description Create an Information Barrier. * @see {@link https://docs.slack.dev/reference/methods/admin.barriers.create `admin.barriers.create` API reference}. */ create: bindApiCall(this, 'admin.barriers.create'), /** * @description Delete an existing Information Barrier. * @see {@link https://docs.slack.dev/reference/methods/admin.barriers.delete `admin.barriers.delete` API reference}. */ delete: bindApiCall(this, 'admin.barriers.delete'), /** * @description Get all Information Barriers for your organization. * @see {@link https://docs.slack.dev/reference/methods/admin.barriers.list `admin.barriers.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.barriers.list'), /** * @description Update an existing Information Barrier. * @see {@link https://docs.slack.dev/reference/methods/admin.barriers.update `admin.barriers.update` API reference}. */ update: bindApiCall(this, 'admin.barriers.update'), }, conversations: { /** * @description Archive a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.archive `admin.conversations.archive` API reference}. */ archive: bindApiCall(this, 'admin.conversations.archive'), /** * @description Archive public or private channels in bulk. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.bulkArchive `admin.conversations.bulkArchive` API reference}. */ bulkArchive: bindApiCall(this, 'admin.conversations.bulkArchive'), /** * @description Delete public or private channels in bulk. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.bulkDelete `admin.conversations.bulkDelete` API reference}. */ bulkDelete: bindApiCall(this, 'admin.conversations.bulkDelete'), /** * @description Move public or private channels in bulk. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.bulkMove `admin.conversations.bulkMove` API reference}. */ bulkMove: bindApiCall(this, 'admin.conversations.bulkMove'), /** * @description Convert a public channel to a private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.convertToPrivate `admin.conversations.convertToPrivate` API reference}. */ convertToPrivate: bindApiCall(this, 'admin.conversations.convertToPrivate'), /** * @description Convert a private channel to a public channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.convertToPublic `admin.conversations.convertToPublic` API reference}. */ convertToPublic: bindApiCall(this, 'admin.conversations.convertToPublic'), /** * @description Create a public or private channel-based conversation. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.create `admin.conversations.create` API reference}. */ create: bindApiCall(this, 'admin.conversations.create'), /** * @description Delete a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.delete `admin.conversations.delete` API reference}. */ delete: bindApiCall(this, 'admin.conversations.delete'), /** * @description Disconnect a connected channel from one or more workspaces. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared `admin.conversations.disconnectShared` API reference}. */ disconnectShared: bindApiCall(this, 'admin.conversations.disconnectShared'), ekm: { /** * @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 {@link https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo `admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference}. */ listOriginalConnectedChannelInfo: bindApiCallWithOptionalArgument(this, 'admin.conversations.ekm.listOriginalConnectedChannelInfo'), }, /** * @description Get conversation preferences for a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.getConversationPrefs `admin.conversations.getConversationPrefs` API reference}. */ getConversationPrefs: bindApiCall(this, 'admin.conversations.getConversationPrefs'), /** * @description Get a conversation's retention policy. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.getCustomRetention `admin.conversations.getCustomRetention` API reference}. */ getCustomRetention: bindApiCall(this, 'admin.conversations.getCustomRetention'), /** * @description Get all the workspaces a given public or private channel is connected to within * this Enterprise org. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.getTeams `admin.conversations.getTeams` API reference}. */ getTeams: bindApiCall(this, 'admin.conversations.getTeams'), /** * @description Invite a user to a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.invite `admin.conversations.invite` API reference}. */ invite: bindApiCall(this, 'admin.conversations.invite'), /** * @description Returns channels on the given team using the filters. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.lookup `admin.conversations.lookup` API reference}. */ lookup: bindApiCall(this, 'admin.conversations.lookup'), /** * @description Remove a conversation's retention policy. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.removeCustomRetention `admin.conversations.removeCustomRetention` API reference}. */ removeCustomRetention: bindApiCall(this, 'admin.conversations.removeCustomRetention'), /** * @description Rename a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.rename `admin.conversations.rename` API reference}. */ rename: bindApiCall(this, 'admin.conversations.rename'), restrictAccess: { /** * @description Add an allowlist of IDP groups for accessing a channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup `admin.conversations.restrictAccess.addGroup` API reference}. */ addGroup: bindApiCall(this, 'admin.conversations.restrictAccess.addGroup'), /** * @description List all IDP Groups linked to a channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups `admin.conversations.restrictAccess.listGroups` API reference}. */ listGroups: bindApiCall(this, 'admin.conversations.restrictAccess.listGroups'), /** * @description Remove a linked IDP group linked from a private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.removeGroup `admin.conversations.restrictAccess.removeGroup` API reference}. */ removeGroup: bindApiCall(this, 'admin.conversations.restrictAccess.removeGroup'), }, /** * @description Search for public or private channels in an Enterprise organization. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.search `admin.conversations.search` API reference}. */ search: bindApiCallWithOptionalArgument(this, 'admin.conversations.search'), /** * @description Set the posting permissions for a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs `admin.conversations.setConversationPrefs` API reference}. */ setConversationPrefs: bindApiCall(this, 'admin.conversations.setConversationPrefs'), /** * @description Set a conversation's retention policy. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.setCustomRetention `admin.conversations.setCustomRetention` API reference}. */ setCustomRetention: bindApiCall(this, 'admin.conversations.setCustomRetention'), /** * @description Set the workspaces in an Enterprise grid org that connect to a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.setTeams `admin.conversations.setTeams` API reference}. */ setTeams: bindApiCall(this, 'admin.conversations.setTeams'), /** * @description Unarchive a public or private channel. * @see {@link https://docs.slack.dev/reference/methods/admin.conversations.unarchive `admin.conversations.unarchive` API reference}. */ unarchive: bindApiCall(this, 'admin.conversations.unarchive'), }, emoji: { /** * @description Add an emoji. * @see {@link https://docs.slack.dev/reference/methods/admin.emoji.add `admin.emoji.add` API reference}. */ add: bindApiCall(this, 'admin.emoji.add'), /** * @description Add an emoji alias. * @see {@link https://docs.slack.dev/reference/methods/admin.emoji.addAlias `admin.emoji.addAlias` API reference}. */ addAlias: bindApiCall(this, 'admin.emoji.addAlias'), /** * @description List emoji for an Enterprise Grid organization. * @see {@link https://docs.slack.dev/reference/methods/admin.emoji.list `admin.emoji.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.emoji.list'), /** * @description Remove an emoji across an Enterprise Grid organization. * @see {@link https://docs.slack.dev/reference/methods/admin.emoji.remove `admin.emoji.remove` API reference}. */ remove: bindApiCall(this, 'admin.emoji.remove'), /** * @description Rename an emoji. * @see {@link https://docs.slack.dev/reference/methods/admin.emoji.rename `admin.emoji.rename` API reference}. */ rename: bindApiCall(this, 'admin.emoji.rename'), }, functions: { /** * @description Look up functions by a set of apps. * @see {@link https://docs.slack.dev/reference/methods/admin.functions.list `admin.functions.list` API reference}. */ list: bindApiCall(this, 'admin.functions.list'), permissions: { /** * @description Lookup the visibility of multiple Slack functions and include the users if * it is limited to particular named entities. * @see {@link https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup `admin.functions.permissions.lookup` API reference}. */ lookup: bindApiCall(this, 'admin.functions.permissions.lookup'), /** * @description Set the visibility of a Slack function and define the users or workspaces if * it is set to named_entities. * @see {@link https://docs.slack.dev/reference/methods/admin.functions.permissions.set `admin.functions.permissions.set` API reference}. */ set: bindApiCall(this, 'admin.functions.permissions.set'), }, }, inviteRequests: { /** * @description Approve a workspace invite request. * @see {@link https://docs.slack.dev/reference/methods/admin.inviteRequests.approve `admin.inviteRequests.approve` API reference}. */ approve: bindApiCall(this, 'admin.inviteRequests.approve'), approved: { /** * @description List all approved workspace invite requests. * @see {@link https://docs.slack.dev/reference/methods/admin.inviteRequests.approved.list `admin.inviteRequests.approved.list` API reference}. */ list: bindApiCall(this, 'admin.inviteRequests.approved.list'), }, denied: { /** * @description List all denied workspace invite requests. * @see {@link https://docs.slack.dev/reference/methods/admin.inviteRequests.denied.list `admin.inviteRequests.denied.list` API reference}. */ list: bindApiCall(this, 'admin.inviteRequests.denied.list'), }, /** * @description Deny a workspace invite request. * @see {@link https://docs.slack.dev/reference/methods/admin.inviteRequests.deny `admin.inviteRequests.deny` API reference}. */ deny: bindApiCall(this, 'admin.inviteRequests.deny'), /** * @description List all pending workspace invite requests. * @see {@link https://docs.slack.dev/reference/methods/admin.inviteRequests.list `admin.inviteRequests.list` API reference}. */ list: bindApiCall(this, 'admin.inviteRequests.list'), }, roles: { /** * @description Adds members to the specified role with the specified scopes. * @see {@link https://docs.slack.dev/reference/methods/admin.roles.addAssignments `admin.roles.addAssignments` API reference}. */ addAssignments: bindApiCall(this, 'admin.roles.addAssignments'), /** * @description Lists assignments for all roles across entities. * Options to scope results by any combination of roles or entities. * @see {@link https://docs.slack.dev/reference/methods/admin.roles.listAssignments `admin.roles.listAssignments` API reference}. */ listAssignments: bindApiCallWithOptionalArgument(this, 'admin.roles.listAssignments'), /** * @description Removes a set of users from a role for the given scopes and entities. * @see {@link https://docs.slack.dev/reference/methods/admin.roles.removeAssignments `admin.roles.removeAssignments` API reference}. */ removeAssignments: bindApiCall(this, 'admin.roles.removeAssignments'), }, teams: { admins: { /** * @description List all of the admins on a given workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.admins.list `admin.teams.admins.list` API reference}. */ list: bindApiCall(this, 'admin.teams.admins.list'), }, /** * @description Create an Enterprise team. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.create `admin.teams.create` API reference}. */ create: bindApiCall(this, 'admin.teams.create'), /** * @description List all teams on an Enterprise organization. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.list `admin.teams.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.teams.list'), owners: { /** * @description List all of the owners on a given workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.owners.list `admin.teams.owners.list` API reference}. */ list: bindApiCall(this, 'admin.teams.owners.list'), }, settings: { /** * @description Fetch information about settings in a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.info `admin.teams.settings.info` API reference}. */ info: bindApiCall(this, 'admin.teams.settings.info'), /** * @description Set the default channels of a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.setDefaultChannels `admin.teams.settings.setDefaultChannels` API reference}. */ setDefaultChannels: bindApiCall(this, 'admin.teams.settings.setDefaultChannels'), /** * @description Set the description of a given workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.setDescription `admin.teams.settings.setDescription` API reference}. */ setDescription: bindApiCall(this, 'admin.teams.settings.setDescription'), /** * @description Set the discoverability of a given workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.setDiscoverability `admin.teams.settings.setDiscoverability` API reference}. */ setDiscoverability: bindApiCall(this, 'admin.teams.settings.setDiscoverability'), /** * @description Sets the icon of a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.setIcon `admin.teams.settings.setIcon` API reference}. */ setIcon: bindApiCall(this, 'admin.teams.settings.setIcon'), /** * @description Set the name of a given workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.teams.settings.setName `admin.teams.settings.setName` API reference}. */ setName: bindApiCall(this, 'admin.teams.settings.setName'), }, }, usergroups: { /** * @description Add up to one hundred default channels to an IDP group. * @see {@link https://docs.slack.dev/reference/methods/admin.usergroups.addChannels `admin.teams.usergroups.addChannels` API reference}. */ addChannels: bindApiCall(this, 'admin.usergroups.addChannels'), /** * @description Associate one or more default workspaces with an organization-wide IDP group. * @see {@link https://docs.slack.dev/reference/methods/admin.usergroups.addTeams `admin.teams.usergroups.addTeams` API reference}. */ addTeams: bindApiCall(this, 'admin.usergroups.addTeams'), /** * @description List the channels linked to an org-level IDP group (user group). * @see {@link https://docs.slack.dev/reference/methods/admin.usergroups.listChannels `admin.teams.usergroups.listChannels` API reference}. */ listChannels: bindApiCall(this, 'admin.usergroups.listChannels'), /** * @description Remove one or more default channels from an org-level IDP group (user group). * @see {@link https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels `admin.teams.usergroups.removeChannels` API reference}. */ removeChannels: bindApiCall(this, 'admin.usergroups.removeChannels'), }, users: { /** * @description Add an Enterprise user to a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.users.assign `admin.users.assign` API reference}. */ assign: bindApiCall(this, 'admin.users.assign'), /** * @description Invite a user to a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.users.invite `admin.users.invite` API reference}. */ invite: bindApiCall(this, 'admin.users.invite'), /** * @description List users on a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.users.list `admin.users.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.users.list'), /** * @description Remove a user from a workspace. * @see {@link https://docs.slack.dev/reference/methods/admin.users.remove `admin.users.remove` API reference}. */ remove: bindApiCall(this, 'admin.users.remove'), session: { /** * @description Clear user-specific session settings—the session duration and what happens when the client * closes—for a list of users. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.clearSettings `admin.users.session.clearSettings` API reference}. */ clearSettings: bindApiCall(this, 'admin.users.session.clearSettings'), /** * @description Get user-specific session settings—the session duration and what happens when the client * closes—given a list of users. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.getSettings `admin.users.session.getSettings` API reference}. */ getSettings: bindApiCall(this, 'admin.users.session.getSettings'), /** * @description Revoke a single session for a user. The user will be forced to login to Slack. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.invalidate `admin.users.session.invalidate` API reference}. */ invalidate: bindApiCall(this, 'admin.users.session.invalidate'), /** * @description List active user sessions for an organization. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.list `admin.users.session.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'admin.users.session.list'), /** * @description Wipes all valid sessions on all devices for a given user. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.reset `admin.users.session.reset` API reference}. */ reset: bindApiCall(this, 'admin.users.session.reset'), /** * @description Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.resetBulk `admin.users.session.resetBulk` API reference}. */ resetBulk: bindApiCall(this, 'admin.users.session.resetBulk'), /** * @description Configure the user-level session settings—the session duration and what happens when the client * closes—for one or more users. * @see {@link https://docs.slack.dev/reference/methods/admin.users.session.setSettings `admin.users.session.setSettings` API reference}. */ setSettings: bindApiCall(this, 'admin.users.session.setSettings'), }, /** * @description Set an existing guest, regular user, or owner to be an admin user. * @see {@link https://docs.slack.dev/reference/methods/admin.users.setAdmin `admin.users.setAdmin` API reference}. */ setAdmin: bindApiCall(this, 'admin.users.setAdmin'), /** * @description Set an expiration for a guest user. * @see {@link https://docs.slack.dev/reference/methods/admin.users.setExpiration `admin.users.setExpiration` API reference}. */ setExpiration: bindApiCall(this, 'admin.users.setExpiration'), /** * @description Set an existing guest, regular user, or admin user to be a workspace owner. * @see {@link https://docs.slack.dev/reference/methods/admin.users.setOwner `admin.users.setOwner` API reference}. */ setOwner: bindApiCall(this, 'admin.users.setOwner'), /** * @description Set an existing guest user, admin user, or owner to be a regular user. * @see {@link https://docs.slack.dev/reference/methods/admin.users.setRegular `admin.users.setRegular` API reference}. */ setRegular: bindApiCall(this, 'admin.users.setRegular'), unsupportedVersions: { /** * @description Ask Slackbot to send you an export listing all workspace members using unsupported software, * presented as a zipped CSV file. * @see {@link https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export `admin.users.unsupportedVersions.export` API reference}. */ export: bindApiCall(this, 'admin.users.unsupportedVersions.export'), }, }, workflows: { collaborators: { /** * @description Add collaborators to workflows within the team or enterprise. * @see {@link https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add `admin.workflows.collaborators.add` API reference}. */ add: bindApiCall(this, 'admin.workflows.collaborators.add'), /** * @description Remove collaborators from workflows within the team or enterprise. * @see {@link https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove `admin.workflows.collaborators.remove` API reference}. */ remove: bindApiCall(this, 'admin.workflows.collaborators.remove'), }, permissions: { /** * @description Look up the permissions for a set of workflows. * @see {@link https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup `admin.workflows.permissions.lookup` API reference}. */ lookup: bindApiCall(this, 'admin.workflows.permissions.lookup'), }, /** * @description Search workflows within the team or enterprise. * @see {@link https://docs.slack.dev/reference/methods/admin.workflows.search `admin.workflows.search` API reference}. */ search: bindApiCallWithOptionalArgument(this, 'admin.workflows.search'), /** * @description Unpublish workflows within the team or enterprise. * @see {@link https://docs.slack.dev/reference/methods/admin.workflows.unpublish `admin.workflows.unpublish` API reference}. */ unpublish: bindApiCall(this, 'admin.workflows.unpublish'), }, }; this.api = { /** * @description Checks API calling code. * @see {@link https://docs.slack.dev/reference/methods/api.test `api.test` API reference}. */ test: bindApiCallWithOptionalArgument(this, 'api.test'), }; this.assistant = { threads: { /** * @description Set loading status to indicate that the app is building a response. * @see {@link https://docs.slack.dev/reference/methods/assistant.threads.setStatus `assistant.threads.setStatus` API reference}. */ setStatus: bindApiCall(this, 'assistant.threads.setStatus'), /** * @description Set suggested prompts for the user. Can suggest up to four prompts. * @see {@link https://docs.slack.dev/reference/methods/assistant.threads.setSuggestedPrompts `assistant.threads.setSuggestedPrompts` API reference}. */ setSuggestedPrompts: bindApiCall(this, 'assistant.threads.setSuggestedPrompts'), /** * @description Set the title of the thread. This is shown when a user views the app's chat history. * @see {@link https://docs.slack.dev/reference/methods/assistant.threads.setTitle `assistant.threads.setTitle` API reference}. */ setTitle: bindApiCall(this, 'assistant.threads.setTitle'), }, }; this.apps = { connections: { /** * @description Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive * events and interactive payloads over. * @see {@link https://docs.slack.dev/reference/methods/apps.connections.open `apps.connections.open` API reference}. */ open: bindApiCallWithOptionalArgument(this, 'apps.connections.open'), }, event: { authorizations: { /** * @description Get a list of authorizations for the given event context. * Each authorization represents an app installation that the event is visible to. * @see {@link https://docs.slack.dev/reference/methods/apps.event.authorizations.list `apps.event.authorizations.list` API reference}. */ list: bindApiCall(this, 'apps.event.authorizations.list'), }, }, manifest: { /** * @description Create an app from an app manifest. * @see {@link https://docs.slack.dev/reference/methods/apps.manifest.create `apps.manifest.create` API reference}. */ create: bindApiCall(this, 'apps.manifest.create'), /** * @description Permanently deletes an app created through app manifests. * @see {@link https://docs.slack.dev/reference/methods/apps.manifest.delete `apps.manifest.delete` API reference}. */ delete: bindApiCall(this, 'apps.manifest.delete'), /** * @description Export an app manifest from an existing app. * @see {@link https://docs.slack.dev/reference/methods/apps.manifest.export `apps.manifest.export` API reference}. */ export: bindApiCall(this, 'apps.manifest.export'), /** * @description Update an app from an app manifest. * @see {@link https://docs.slack.dev/reference/methods/apps.manifest.update `apps.manifest.update` API reference}. */ update: bindApiCall(this, 'apps.manifest.update'), /** * @description Validate an app manifest. * @see {@link https://docs.slack.dev/reference/methods/apps.manifest.validate `apps.manifest.validate` API reference}. */ validate: bindApiCall(this, 'apps.manifest.validate'), }, /** * @description Uninstalls your app from a workspace. * @see {@link https://docs.slack.dev/reference/methods/apps.uninstall `apps.uninstall` API reference}. */ uninstall: bindApiCall(this, 'apps.uninstall'), }; this.auth = { /** * @description Revokes a token. * @see {@link https://docs.slack.dev/reference/methods/auth.revoke `auth.revoke` API reference}. */ revoke: bindApiCallWithOptionalArgument(this, 'auth.revoke'), teams: { /** * @description Obtain a full list of workspaces your org-wide app has been approved for. * @see {@link https://docs.slack.dev/reference/methods/auth.teams.list `auth.teams.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'auth.teams.list'), }, test: bindApiCallWithOptionalArgument(this, 'auth.test'), }; this.bookmarks = { /** * @description Add bookmark to a channel. * @see {@link https://docs.slack.dev/reference/methods/bookmarks.add `bookmarks.add` API reference}. */ add: bindApiCall(this, 'bookmarks.add'), /** * @description Edit bookmark. * @see {@link https://docs.slack.dev/reference/methods/bookmarks.edit `bookmarks.edit` API reference}. */ edit: bindApiCall(this, 'bookmarks.edit'), /** * @description List bookmarks for a channel. * @see {@link https://docs.slack.dev/reference/methods/bookmarks.list `bookmarks.list` API reference}. */ list: bindApiCall(this, 'bookmarks.list'), /** * @description Remove bookmark from a channel. * @see {@link https://docs.slack.dev/reference/methods/bookmarks.remove `bookmarks.remove` API reference}. */ remove: bindApiCall(this, 'bookmarks.remove'), }; this.bots = { /** * @description Gets information about a bot user. * @see {@link https://docs.slack.dev/reference/methods/bots.info `bots.info` API reference}. */ info: bindApiCallWithOptionalArgument(this, 'bots.info'), }; this.calls = { /** * @description Registers a new Call. * @see {@link https://docs.slack.dev/reference/methods/calls.add `calls.add` API reference}. */ add: bindApiCall(this, 'calls.add'), /** * @description Ends a Call. * @see {@link https://docs.slack.dev/reference/methods/calls.end `calls.end` API reference}. */ end: bindApiCall(this, 'calls.end'), /** * @description Returns information about a Call. * @see {@link https://docs.slack.dev/reference/methods/calls.info `calls.info` API reference}. */ info: bindApiCall(this, 'calls.info'), /** * @description Updates information about a Call. * @see {@link https://docs.slack.dev/reference/methods/calls.update `calls.update` API reference}. */ update: bindApiCall(this, 'calls.update'), participants: { /** * @description Registers new participants added to a Call. * @see {@link https://docs.slack.dev/reference/methods/calls.participants.add `calls.participants.add` API reference}. */ add: bindApiCall(this, 'calls.participants.add'), remove: bindApiCall(this, 'calls.participants.remove'), }, }; this.canvases = { access: { /** * @description Remove access to a canvas for specified entities. * @see {@link https://docs.slack.dev/reference/methods/canvases.access.delete `canvases.access.delete` API reference}. */ delete: bindApiCall(this, 'canvases.access.delete'), /** * @description Sets the access level to a canvas for specified entities. * @see {@link https://docs.slack.dev/reference/methods/canvases.access.set `canvases.access.set` API reference}. */ set: bindApiCall(this, 'canvases.access.set'), }, /** * @description Create Canvas for a user. * @see {@link https://docs.slack.dev/reference/methods/canvases.create `canvases.create` API reference}. */ create: bindApiCallWithOptionalArgument(this, 'canvases.create'), /** * @description Deletes a canvas. * @see {@link https://docs.slack.dev/reference/methods/canvases.delete `canvases.delete` API reference}. */ delete: bindApiCall(this, 'canvases.delete'), /** * @description Update an existing canvas. * @see {@link https://docs.slack.dev/reference/methods/canvases.edit `canvases.edit` API reference}. */ edit: bindApiCall(this, 'canvases.edit'), sections: { /** * @description Find sections matching the provided criteria. * @see {@link https://docs.slack.dev/reference/methods/canvases.sections.lookup `canvases.sections.lookup` API reference}. */ lookup: bindApiCall(this, 'canvases.sections.lookup'), }, }; this.chat = { /** * @description Appends text to an existing streaming conversation. * @see {@link https://docs.slack.dev/reference/methods/chat.appendStream `chat.appendStream` API reference}. */ appendStream: bindApiCall(this, 'chat.appendStream'), /** * @description Deletes a message. * @see {@link https://docs.slack.dev/reference/methods/chat.delete `chat.delete` API reference}. */ delete: bindApiCall(this, 'chat.delete'), /** * @description Deletes a pending scheduled message from the queue. * @see {@link https://docs.slack.dev/reference/methods/chat.deleteScheduledMessage `chat.deleteScheduledMessage` API reference}. */ deleteScheduledMessage: bindApiCall(this, 'chat.deleteScheduledMessage'), /** * @description Retrieve a permalink URL for a specific extant message. * @see {@link https://docs.slack.dev/reference/methods/chat.getPermalink `chat.getPermalink` API reference}. */ getPermalink: bindApiCall(this, 'chat.getPermalink'), /** * @description Share a me message into a channel. * @see {@link https://docs.slack.dev/reference/methods/chat.meMessage `chat.meMessage` API reference}. */ meMessage: bindApiCall(this, 'chat.meMessage'), /** * @description Sends an ephemeral message to a user in a channel. * @see {@link https://docs.slack.dev/reference/methods/chat.postEphemeral `chat.postEphemeral` API reference}. */ postEphemeral: bindApiCall(this, 'chat.postEphemeral'), /** * @description Sends a message to a channel. * @see {@link https://docs.slack.dev/reference/methods/chat.postMessage `chat.postMessage` API reference}. */ postMessage: bindApiCall(this, 'chat.postMessage'), /** * @description Schedules a message to be sent to a channel. * @see {@link https://docs.slack.dev/reference/methods/chat.scheduleMessage `chat.scheduleMessage` API reference}. */ scheduleMessage: bindApiCall(this, 'chat.scheduleMessage'), scheduledMessages: { /** * @description Returns a list of scheduled messages. * @see {@link https://docs.slack.dev/reference/methods/chat.scheduledMessages.list `chat.scheduledMessages.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'chat.scheduledMessages.list'), }, /** * @description Starts a new streaming conversation. * @see {@link https://docs.slack.dev/reference/methods/chat.startStream `chat.startStream` API reference}. */ startStream: bindApiCall(this, 'chat.startStream'), /** * @description Stops a streaming conversation. * @see {@link https://docs.slack.dev/reference/methods/chat.stopStream `chat.stopStream` API reference}. */ stopStream: bindApiCall(this, 'chat.stopStream'), /** * @description Provide custom unfurl behavior for user-posted URLs. * @see {@link https://docs.slack.dev/reference/methods/chat.unfurl `chat.unfurl` API reference}. */ unfurl: bindApiCall(this, 'chat.unfurl'), /** * @description Updates a message. * @see {@link https://docs.slack.dev/reference/methods/chat.update `chat.update` API reference}. */ update: bindApiCall(this, 'chat.update'), }; this.conversations = { /** * @description Accepts an invitation to a Slack Connect channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite `conversations.acceptSharedInvite` API reference}. */ acceptSharedInvite: bindApiCall(this, 'conversations.acceptSharedInvite'), /** * @description Approves an invitation to a Slack Connect channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.approveSharedInvite `conversations.approveSharedInvite` API reference}. */ approveSharedInvite: bindApiCall(this, 'conversations.approveSharedInvite'), /** * @description Archives a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.archive `conversations.archive` API reference}. */ archive: bindApiCall(this, 'conversations.archive'), canvases: { /** * @description Create a Channel Canvas for a channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.canvases.create `conversations.canvases.create` API reference}. */ create: bindApiCall(this, 'conversations.canvases.create'), }, /** * @description Closes a direct message or multi-person direct message. * @see {@link https://docs.slack.dev/reference/methods/conversations.close `conversations.close` API reference}. */ close: bindApiCall(this, 'conversations.close'), /** * @description Initiates a public or private channel-based conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.create `conversations.create` API reference}. */ create: bindApiCall(this, 'conversations.create'), /** * @description Declines an invitation to a Slack Connect channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.declineSharedInvite `conversations.declineSharedInvite` API reference}. */ declineSharedInvite: bindApiCall(this, 'conversations.declineSharedInvite'), externalInvitePermissions: { /** * @description Convert a team in a shared channel from an External Limited channel to a fully shared Slack * Connect channel or vice versa. * @see {@link https://docs.slack.dev/reference/methods/conversations.externalInvitePermissions.set `conversations.externalInvitePermissions.set` API reference}. */ set: bindApiCall(this, 'conversations.externalInvitePermissions.set'), }, /** * @description Fetches a conversation's history of messages and events. * @see {@link https://docs.slack.dev/reference/methods/conversations.history `conversations.history` API reference}. */ history: bindApiCall(this, 'conversations.history'), /** * @description Retrieve information about a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.info `conversations.info` API reference}. */ info: bindApiCall(this, 'conversations.info'), /** * @description Invites users to a channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.invite `conversations.invite` API reference}. */ invite: bindApiCall(this, 'conversations.invite'), /** * @description Sends an invitation to a Slack Connect channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.inviteShared `conversations.inviteShared` API reference}. */ inviteShared: bindApiCall(this, 'conversations.inviteShared'), /** * @description Joins an existing conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.join `conversations.join` API reference}. */ join: bindApiCall(this, 'conversations.join'), /** * @description Removes a user from a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.kick `conversations.kick` API reference}. */ kick: bindApiCall(this, 'conversations.kick'), /** * @description Leaves a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.leave `conversations.leave` API reference}. */ leave: bindApiCall(this, 'conversations.leave'), /** * @description List all channels in a Slack team. * @see {@link https://docs.slack.dev/reference/methods/conversations.list `conversations.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'conversations.list'), /** * @description Lists shared channel invites that have been generated or received but have not been approved by * all parties. * @see {@link https://docs.slack.dev/reference/methods/conversations.listConnectInvites `conversations.listConnectInvites` API reference}. */ listConnectInvites: bindApiCallWithOptionalArgument(this, 'conversations.listConnectInvites'), /** * @description Sets the read cursor in a channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.mark `conversations.mark` API reference}. */ mark: bindApiCall(this, 'conversations.mark'), /** * @description Retrieve members of a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.members `conversations.members` API reference}. */ members: bindApiCall(this, 'conversations.members'), /** * @description Opens or resumes a direct message or multi-person direct message. * @see {@link https://docs.slack.dev/reference/methods/conversations.open `conversations.open` API reference}. */ open: bindApiCall(this, 'conversations.open'), /** * @description Renames a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.rename `conversations.rename` API reference}. */ rename: bindApiCall(this, 'conversations.rename'), /** * @description Retrieve a thread of messages posted to a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.replies `conversations.replies` API reference}. */ replies: bindApiCall(this, 'conversations.replies'), requestSharedInvite: { /** * @description Approves a request to add an external user to a channel and sends them a Slack Connect invite. * @see {@link https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.approve `conversations.requestSharedInvite.approve` API reference}. */ approve: bindApiCall(this, 'conversations.requestSharedInvite.approve'), /** * @description Denies a request to invite an external user to a channel. * @see {@link https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.deny `conversations.requestSharedInvite.deny` API reference}. */ deny: bindApiCall(this, 'conversations.requestSharedInvite.deny'), /** * @description Lists requests to add external users to channels with ability to filter. * @see {@link https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.list `conversations.requestSharedInvite.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'conversations.requestSharedInvite.list'), }, /** * @description Sets the purpose for a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.setPurpose `conversations.setPurpose` API reference}. */ setPurpose: bindApiCall(this, 'conversations.setPurpose'), /** * @description Sets the topic for a conversation. * @see {@link https://docs.slack.dev/reference/methods/conversations.setTopic `conversations.setTopic` API reference}. */ setTopic: bindApiCall(this, 'conversations.setTopic'), /** * @description Reverses conversation archival. * @see {@link https://docs.slack.dev/reference/methods/conversations.unarchive `conversations.unarchive` API reference}. */ unarchive: bindApiCall(this, 'conversations.unarchive'), }; this.dialog = { /** * @description Open a dialog with a user. * @see {@link https://docs.slack.dev/reference/methods/dialog.open `dialog.open` API reference}. */ open: bindApiCall(this, 'dialog.open'), }; this.dnd = { /** * @description Ends the current user's Do Not Disturb session immediately. * @see {@link https://docs.slack.dev/reference/methods/dnd.endDnd `dnd.endDnd` API reference}. */ endDnd: bindApiCallWithOptionalArgument(this, 'dnd.endDnd'), /** * @description Ends the current user's snooze mode immediately. * @see {@link https://docs.slack.dev/reference/methods/dnd.endSnooze `dnd.endSnooze` API reference}. */ endSnooze: bindApiCallWithOptionalArgument(this, 'dnd.endSnooze'), /** * @description Retrieves a user's current Do Not Disturb status. * @see {@link https://docs.slack.dev/reference/methods/dnd.info `dnd.info` API reference}. */ info: bindApiCallWithOptionalArgument(this, 'dnd.info'), /** * @description Turns on Do Not Disturb mode for the current user, or changes its duration. * @see {@link https://docs.slack.dev/reference/methods/dnd.setSnooze `dnd.setSnooze` API reference}. */ setSnooze: bindApiCall(this, 'dnd.setSnooze'), /** * @description Retrieves the Do Not Disturb status for up to 50 users on a team. * @see {@link https://docs.slack.dev/reference/methods/dnd.teamInfo `dnd.teamInfo` API reference}. */ teamInfo: bindApiCall(this, 'dnd.teamInfo'), }; this.emoji = { /** * @description Lists custom emoji for a team. * @see {@link https://docs.slack.dev/reference/methods/emoji.list `emoji.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'emoji.list'), }; this.entity = { /** * @description Provide information about the entity to be displayed in the flexpane. * @see {@link https://docs.slack.dev/reference/methods/entity.presentDetails} */ presentDetails: bindApiCall(this, 'entity.presentDetails'), }; this.files = { /** * @description Finishes an upload started with {@link https://docs.slack.dev/reference/methods/files.getUploadURLExternal `files.getUploadURLExternal`}. * @see {@link https://docs.slack.dev/reference/methods/files.completeUploadExternal `files.completeUploadExternal` API reference}. */ completeUploadExternal: bindApiCall(this, 'files.completeUploadExternal'), /** * @description Deletes a file. * @see {@link https://docs.slack.dev/reference/methods/files.delete `files.delete` API reference}. */ delete: bindApiCall(this, 'files.delete'), /** * @description Gets a URL for an edge external file upload. * @see {@link https://docs.slack.dev/reference/methods/files.getUploadURLExternal `files.getUploadURLExternal` API reference}. */ getUploadURLExternal: bindApiCall(this, 'files.getUploadURLExternal'), /** * @description Gets information about a file. * @see {@link https://docs.slack.dev/reference/methods/files.info `files.info` API reference}. */ info: bindApiCall(this, 'files.info'), /** * @description List files for a team, in a channel, or from a user with applied filters. * @see {@link https://docs.slack.dev/reference/methods/files.list `files.list` API reference}. */ list: bindApiCall(this, 'files.list'), /** * @description Revokes public/external sharing access for a file. * @see {@link https://docs.slack.dev/reference/methods/files.revokePublicURL `files.revokePublicURL` API reference}. */ revokePublicURL: bindApiCall(this, 'files.revokePublicURL'), /** * @description Enables a file for public/external sharing. * @see {@link https://docs.slack.dev/reference/methods/files.sharedPublicURL `files.sharedPublicURL` API reference}. */ sharedPublicURL: bindApiCall(this, 'files.sharedPublicURL'), /** * @description Uploads or creates a file. * @deprecated Use `uploadV2` instead. See {@link https://docs.slack.dev/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay our post on retiring `files.upload`}. * @see {@link https://docs.slack.dev/reference/methods/files.upload `files.upload` API reference}. */ upload: bindApiCall(this, 'files.upload'), /** * @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 {@link https://docs.slack.dev/tools/node-slack-sdk/web-api/#upload-a-file `@slack/web-api` Upload a file documentation}. */ uploadV2: bindFilesUploadV2(this), comments: { /** * @description Deletes an existing comment on a file. * @see {@link https://docs.slack.dev/reference/methods/files.comments.delete `files.comments.delete` API reference}. */ delete: bindApiCall(this, 'files.comments.delete'), }, remote: { /** * @description Adds a file from a remote service. * @see {@link https://docs.slack.dev/reference/methods/files.remote.add `files.remote.add` API reference}. */ add: bindApiCall(this, 'files.remote.add'), /** * @description Retrieve information about a remote file added to Slack. * @see {@link https://docs.slack.dev/reference/methods/files.remote.info `files.remote.info` API reference}. */ info: bindApiCall(this, 'files.remote.info'), /** * @description List remote files added to Slack. * @see {@link https://docs.slack.dev/reference/methods/files.remote.list `files.remote.list` API reference}. */ list: bindApiCall(this, 'files.remote.list'), /** * @description Remove a remote file. * @see {@link https://docs.slack.dev/reference/methods/files.remote.remove `files.remote.remove` API reference}. */ remove: bindApiCall(this, 'files.remote.remove'), /** * @description Share a remote file into a channel. * @see {@link https://docs.slack.dev/reference/methods/files.remote.share `files.remote.share` API reference}. */ share: bindApiCall(this, 'files.remote.share'), /** * @description Updates an existing remote file. * @see {@link https://docs.slack.dev/reference/methods/files.remote.update `files.remote.update` API reference}. */ update: bindApiCall(this, 'files.remote.update'), }, }; this.functions = { /** * @description Signal the failure to execute a Custom Function. * @see {@link https://docs.slack.dev/reference/methods/functions.completeError `functions.completeError` API reference}. */ completeError: bindApiCall(this, 'functions.completeError'), /** * @description Signal the successful completion of a Custom Function. * @see {@link https://docs.slack.dev/reference/methods/functions.completeSuccess `functions.completeSuccess` API reference}. */ completeSuccess: bindApiCall(this, 'functions.completeSuccess'), }; this.migration = { /** * @description For Enterprise Grid workspaces, map local user IDs to global user IDs. * @see {@link https://docs.slack.dev/reference/methods/migration.exchange `migration.exchange` API reference}. */ exchange: bindApiCall(this, 'migration.exchange'), }; this.oauth = { /** * @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 {@link https://docs.slack.dev/reference/methods/oauth.access `oauth.access` API reference}. */ access: bindApiCall(this, 'oauth.access'), v2: { /** * @description Exchanges a temporary OAuth verifier code for an access token. * @see {@link https://docs.slack.dev/reference/methods/oauth.v2.access `oauth.v2.access` API reference}. */ access: bindApiCall(this, 'oauth.v2.access'), /** * @description Exchanges a legacy access token for a new expiring access token and refresh token. * @see {@link https://docs.slack.dev/reference/methods/oauth.v2.exchange `oauth.v2.exchange` API reference}. */ exchange: bindApiCall(this, 'oauth.v2.exchange'), }, }; this.openid = { connect: { /** * @description Exchanges a temporary OAuth verifier code for an access token for {@link https://docs.slack.dev/authentication/sign-in-with-slack Sign in with Slack}. * @see {@link https://docs.slack.dev/reference/methods/openid.connect.token `openid.connect.token` API reference}. */ token: bindApiCall(this, 'openid.connect.token'), /** * @description Get the identity of a user who has authorized {@link https://docs.slack.dev/authentication/sign-in-with-slack Sign in with Slack}. * @see {@link https://docs.slack.dev/reference/methods/openid.connect.userInfo `openid.connect.userInfo` API reference}. */ userInfo: bindApiCallWithOptionalArgument(this, 'openid.connect.userInfo'), }, }; this.pins = { /** * @description Pins an item to a channel. * @see {@link https://docs.slack.dev/reference/methods/pins.add `pins.add` API reference}. */ add: bindApiCall(this, 'pins.add'), /** * @description Lists items pinned to a channel. * @see {@link https://docs.slack.dev/reference/methods/pins.list `pins.list` API reference}. */ list: bindApiCall(this, 'pins.list'), /** * @description Un-pins an item from a channel. * @see {@link https://docs.slack.dev/reference/methods/pins.remove `pins.remove` API reference}. */ remove: bindApiCall(this, 'pins.remove'), }; this.reactions = { /** * @description Adds a reaction to an item. * @see {@link https://docs.slack.dev/reference/methods/reactions.add `reactions.add` API reference}. */ add: bindApiCall(this, 'reactions.add'), /** * @description Gets reactions for an item. * @see {@link https://docs.slack.dev/reference/methods/reactions.get `reactions.get` API reference}. */ get: bindApiCall(this, 'reactions.get'), /** * @description List reactions made by a user. * @see {@link https://docs.slack.dev/reference/methods/reactions.list `reactions.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'reactions.list'), /** * @description Removes a reaction from an item. * @see {@link https://docs.slack.dev/reference/methods/reactions.remove `reactions.remove` API reference}. */ remove: bindApiCall(this, 'reactions.remove'), }; // TODO: keep tabs on reminders APIs, may be deprecated once Later list APIs land // See: https://docs.slack.dev/changelog/2023-07-its-later-already-for-stars-and-reminders this.reminders = { /** * @description Creates a reminder. * @see {@link https://docs.slack.dev/reference/methods/reminders.add `reminders.add` API reference}. */ add: bindApiCall(this, 'reminders.add'), /** * @description Marks a reminder as complete. * @see {@link https://docs.slack.dev/reference/methods/reminders.complete `reminders.complete` API reference}. */ complete: bindApiCall(this, 'reminders.complete'), /** * @description Deletes a reminder. * @see {@link https://docs.slack.dev/reference/methods/reminders.delete `reminders.delete` API reference}. */ delete: bindApiCall(this, 'reminders.delete'), /** * @description Gets information about a reminder. * @see {@link https://docs.slack.dev/reference/methods/reminders.info `reminders.info` API reference}. */ info: bindApiCall(this, 'reminders.info'), /** * @description Lists all reminders created by or for a given user. * @see {@link https://docs.slack.dev/reference/methods/reminders.list `reminders.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'reminders.list'), }; this.rtm = { /** * @description Starts a Real Time Messaging session. * @see {@link https://docs.slack.dev/reference/methods/rtm.connect `rtm.connect` API reference}. */ connect: bindApiCallWithOptionalArgument(this, 'rtm.connect'), /** * @description Starts a Real Time Messaging session. * @deprecated Use `rtm.connect` instead. See {@link https://docs.slack.dev/changelog/2021-10-rtm-start-to-stop our post on retiring `rtm.start`}. * @see {@link https://docs.slack.dev/reference/methods/rtm.start `rtm.start` API reference}. */ start: bindApiCallWithOptionalArgument(this, 'rtm.start'), }; this.search = { /** * @description Searches for messages and files matching a query. * @see {@link https://docs.slack.dev/reference/methods/search.all search.all` API reference}. */ all: bindApiCall(this, 'search.all'), /** * @description Searches for files matching a query. * @see {@link https://docs.slack.dev/reference/methods/search.files search.files` API reference}. */ files: bindApiCall(this, 'search.files'), /** * @description Searches for messages matching a query. * @see {@link https://docs.slack.dev/reference/methods/search.messages search.messages` API reference}. */ messages: bindApiCall(this, 'search.messages'), }; this.slackLists = { access: { /** * @description Delete access for specified entities. * @see {@link https://docs.slack.dev/reference/methods/slackLists.access.delete `slackLists.access.delete` API reference}. */ delete: bindApiCall(this, 'slackLists.access.delete'), /** * @description Set access level for specified entities. * @see {@link https://docs.slack.dev/reference/methods/slackLists.access.set `slackLists.access.set` API reference}. */ set: bindApiCall(this, 'slackLists.access.set'), }, /** * @description Create a List. * @see {@link https://docs.slack.dev/reference/methods/slackLists.create `slackLists.create` API reference}. */ create: bindApiCall(this, 'slackLists.create'), download: { /** * @description Get download job status. * @see {@link https://docs.slack.dev/reference/methods/slackLists.download.get `slackLists.download.get` API reference}. */ get: bindApiCall(this, 'slackLists.download.get'), /** * @description Start a download job for a list. * @see {@link https://docs.slack.dev/reference/methods/slackLists.download.start `slackLists.download.start` API reference}. */ start: bindApiCall(this, 'slackLists.download.start'), }, items: { /** * @description Create a list item. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.create `slackLists.items.create` API reference}. */ create: bindApiCall(this, 'slackLists.items.create'), /** * @description Delete a list item. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.delete `slackLists.items.delete` API reference}. */ delete: bindApiCall(this, 'slackLists.items.delete'), /** * @description Delete multiple list items. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.deleteMultiple `slackLists.items.deleteMultiple` API reference}. */ deleteMultiple: bindApiCall(this, 'slackLists.items.deleteMultiple'), /** * @description Get info about a list item. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.info `slackLists.items.info` API reference}. */ info: bindApiCall(this, 'slackLists.items.info'), /** * @description Get records from a List. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.list `slackLists.items.list` API reference}. */ list: bindApiCall(this, 'slackLists.items.list'), /** * @description Update a list item. * @see {@link https://docs.slack.dev/reference/methods/slackLists.items.update `slackLists.items.update` API reference}. */ update: bindApiCall(this, 'slackLists.items.update'), }, /** * @description Update a list. * @see {@link https://docs.slack.dev/reference/methods/slackLists.update `slackLists.update` API reference}. */ update: bindApiCall(this, 'slackLists.update'), }; this.team = { /** * @description Gets the access logs for the current team. * @see {@link https://docs.slack.dev/reference/methods/team.accessLogs `team.accessLogs` API reference}. */ accessLogs: bindApiCallWithOptionalArgument(this, 'team.accessLogs'), /** * @description Gets billable users information for the current team. * @see {@link https://docs.slack.dev/reference/methods/team.billableInfo `team.billableInfo` API reference}. */ billableInfo: bindApiCallWithOptionalArgument(this, 'team.billableInfo'), billing: { /** * @description Reads a workspace's billing plan information. * @see {@link https://docs.slack.dev/reference/methods/team.billing.info `team.billing.info` API reference}. */ info: bindApiCall(this, 'team.billing.info'), }, externalTeams: { /** * @description Disconnect an external organization. * @see {@link https://docs.slack.dev/reference/methods/team.externalTeams.disconnect `team.externalTeams.disconnect` API reference}. */ disconnect: bindApiCall(this, 'team.externalTeams.disconnect'), /** * @description Returns a list of all the external teams connected and details about the connection. * @see {@link https://docs.slack.dev/reference/methods/team.externalTeams.list `team.externalTeams.list` API reference}. */ list: bindApiCall(this, 'team.externalTeams.list'), }, /** * @description Gets information about the current team. * @see {@link https://docs.slack.dev/reference/methods/team.info `team.info` API reference}. */ info: bindApiCallWithOptionalArgument(this, 'team.info'), /** * @description Gets the integration logs for the current team. * @see {@link https://docs.slack.dev/reference/methods/team.integrationLogs `team.integrationLogs` API reference}. */ integrationLogs: bindApiCallWithOptionalArgument(this, 'team.integrationLogs'), preferences: { /** * @description Retrieve a list of a workspace's team preferences. * @see {@link https://docs.slack.dev/reference/methods/team.preferences.list `team.preferences.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'team.preferences.list'), }, profile: { /** * @description Retrieve a team's profile. * @see {@link https://docs.slack.dev/reference/methods/team.profile.get `team.profile.get` API reference}. */ get: bindApiCallWithOptionalArgument(this, 'team.profile.get'), }, }; this.tooling = { tokens: { /** * @description Exchanges a refresh token for a new app configuration token. * @see {@link https://docs.slack.dev/reference/methods/tooling.tokens.rotate `tooling.tokens.rotate` API reference}. */ rotate: bindApiCall(this, 'tooling.tokens.rotate'), }, }; this.usergroups = { /** * @description Create a User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.create `usergroups.create` API reference}. */ create: bindApiCall(this, 'usergroups.create'), /** * @description Disable an existing User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.disable `usergroups.disable` API reference}. */ disable: bindApiCall(this, 'usergroups.disable'), /** * @description Enable an existing User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.enable `usergroups.enable` API reference}. */ enable: bindApiCall(this, 'usergroups.enable'), /** * @description List all User Groups for a team. * @see {@link https://docs.slack.dev/reference/methods/usergroups.list `usergroups.list` API reference}. */ list: bindApiCallWithOptionalArgument(this, 'usergroups.list'), /** * @description Update an existing User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.update `usergroups.update` API reference}. */ update: bindApiCall(this, 'usergroups.update'), users: { /** * @description List all users in a User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.users.list `usergroups.users.list` API reference}. */ list: bindApiCall(this, 'usergroups.users.list'), /** * @description Update the list of users in a User Group. * @see {@link https://docs.slack.dev/reference/methods/usergroups.users.update `usergroups.users.update` API reference}. */ update: bindApiCall(this, 'usergroups.users.update'), }, }; this.users = { /** * @description List conversations the calling user may access. * @see {@link https://docs.slack.dev/reference/methods/users.conversations `users.conversations` API reference}. */ conversations: bindApiCall(this, 'users.conversations'), /** * @description Delete the user profile photo. * @see {@link https://docs.slack.dev/reference/methods/users.deletePhoto `users.deletePhoto` API reference}. */ deletePhoto: bindApiCall(this, 'users.deletePhoto'), discoverableContacts: { /** * @description Lookup an email address to see if someone is on Slack. * @see {@link https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup `users.discoverableContacts.lookup` API reference}. */ lookup: bindApiCall(this, 'users.discoverableContacts.lookup'), }, /** * @description Gets user presence information. * @see {@link https://docs.slack.dev/reference/methods/users.getPresence `users.getPresence` API reference}. */ getPresence: bindApiCall(this, 'users.getPresence'), /** * @description Get a user's identity. * @see {@link https://docs.slack.dev/reference/methods/users.identity `users.identity` API reference}. */ identity: bindApiCall(this, 'users.identity'), /** * @description Gets information about a user. * @see {@link https://docs.slack.dev/reference/methods/users.info `users.info` API reference}. */ info: bindApiCall(this, 'users.info'), /** * @description Lists all users in a Slack team. * @see {@link https://docs.slack.dev/reference/methods/users.list `users.list` API reference}. */ list: bindApiCall(this, 'users.list'), /** * @description Find a user with an email address. * @see {@link https://docs.slack.dev/reference/methods/users.lookupByEmail `users.lookupByEmail` API reference}. */ lookupByEmail: bindApiCall(this, 'users.lookupByEmail'), /** * @description Set the user profile photo. * @see {@link https://docs.slack.dev/reference/methods/users.setPhoto `users.setPhoto` API reference}. */ setPhoto: bindApiCall(this, 'users.setPhoto'), /** * @description Manually sets user presence. * @see {@link https://docs.slack.dev/reference/methods/users.setPresence `users.setPresence` API reference}. */ setPresence: bindApiCall(this, 'users.setPresence'), profile: { /** * @description Retrieve a user's profile information, including their custom status. * @see {@link https://docs.slack.dev/reference/methods/users.profile.get `users.profile.get` API reference}. */ get: bindApiCall(this, 'users.profile.get'), /** * @description Set a user's profile information, including custom status. * @see {@link https://docs.slack.dev/reference/methods/users.profile.set `users.profile.set` API reference}. */ set: bindApiCall(this, 'users.profile.set'), }, }; this.views = { /** * @description Open a view for a user. * @see {@link https://docs.slack.dev/reference/methods/views.open `views.open` API reference}. */ open: bindApiCall(this, 'views.open'), /** * @description Publish a static view for a user. * @see {@link https://docs.slack.dev/reference/methods/views.publish `views.publish` API reference}. */ publish: bindApiCall(this, 'views.publish'), /** * @description Push a view onto the stack of a root view. * @see {@link https://docs.slack.dev/reference/methods/views.push `views.push` API reference}. */ push: bindApiCall(this, 'views.push'), /** * @description Update an existing view. * @see {@link https://docs.slack.dev/reference/methods/views.update `views.update` API reference}. */ update: bindApiCall(this, 'views.update'), }; // ------------------ // Deprecated methods // ------------------ // TODO: breaking changes for future majors: // - stars.* methods are marked as deprecated; once Later has APIs, these will see an official sunsetting timeline // - workflows.* methods, Sep 12 2024: https://docs.slack.dev/changelog/2023-08-workflow-steps-from-apps-step-back this.stars = { /** * @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 {@link https://docs.slack.dev/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}. * @see {@link https://docs.slack.dev/reference/methods/stars.add `stars.add` API reference}. */ add: bindApiCall(this, 'stars.add'), /** * @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 {@link https://docs.slack.dev/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}. * @see {@link https://docs.slack.dev/reference/methods/stars.list `stars.list` API reference}. */ list: bindApiCall(this, 'stars.list'), /** * @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 {@link https://docs.slack.dev/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}. * @see {@link https://docs.slack.dev/reference/methods/stars.remove `stars.remove` API reference}. */ remove: bindApiCall(this, 'stars.remove'), }; this.workflows = { featured: { /** * @description Add featured workflows to a channel. * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.add `workflows.featured.add` API reference}. */ add: bindApiCall(this, 'workflows.featured.add'), /** * @description List the featured workflows for specified channels. * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.list `workflows.featured.list` API reference}. */ list: bindApiCall(this, 'workflows.featured.list'), /** * @description Remove featured workflows from a channel. * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.remove `workflows.featured.remove` API reference}. */ remove: bindApiCall(this, 'workflows.featured.remove'), /** * @description Set featured workflows for a channel. * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.set `workflows.featured.set` API reference}. */ set: bindApiCall(this, 'workflows.featured.set'), }, /** * @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 {@link https://docs.slack.dev/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}. * @see {@link https://docs.slack.dev/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object `workflows.stepCompleted` API reference}. */ stepCompleted: bindApiCall(this, 'workflows.stepCompleted'), /** * @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 {@link https://docs.slack.dev/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}. * @see {@link https://docs.slack.dev/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object `workflows.stepFailed` API reference}. */ stepFailed: bindApiCall(this, 'workflows.stepFailed'), /** * @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 {@link https://docs.slack.dev/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}. * @see {@link https://docs.slack.dev/legacy/legacy-steps-from-apps/legacy-steps-from-apps-workflow_step-object `workflows.updateStep` API reference}. */ updateStep: bindApiCall(this, 'workflows.updateStep'), }; // Check that the class being created extends from `WebClient` rather than this class if (new.target !== WebClient_1.WebClient && !(new.target.prototype instanceof WebClient_1.WebClient)) { throw new Error('Attempt to inherit from WebClient methods without inheriting from WebClient'); } } } exports.Methods = Methods; __exportStar(require("@slack/types"), exports); //# sourceMappingURL=methods.js.map