Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/slack_web_api_client/mod.ts>SlackAPIClient

Streamlined Slack Web API client for TypeScript
Go to Latest
class SlackAPIClient
Re-export
import { SlackAPIClient } from "https://deno.land/x/slack_web_api_client@0.7.5/mod.ts";

Constructors

new
SlackAPIClient(token?: string | undefined, options?: SlackAPIClientOptions)

Properties

readonly
admin: { apps: { approve; approved: { list; }; clearResolution; requests: { cancel; list; }; restrict; restricted: { list; }; uninstall; activities: { list; }; }; auth: { policy: { assignEntities; getEntities; removeEntities; }; }; barriers: { create; delete; list; update; }; conversations: { archive; bulkArchive; bulkDelete; bulkMove; convertToPrivate; convertToPublic; create; delete; disconnectShared; ekm: { listOriginalConnectedChannelInfo; }; getConversationPrefs; getTeams; invite; rename; restrictAccess: { addGroup; listGroups; removeGroup; }; getCustomRetention; setCustomRetention; removeCustomRetention; lookup; search; setConversationPrefs; setTeams; unarchive; }; emoji: { add; addAlias; list; remove; rename; }; functions: { list; permissions: { lookup; set; }; }; inviteRequests: { approve; approved: { list; }; denied: { list; }; deny; list; }; roles: { addAssignments; listAssignments; removeAssignments; }; teams: { admins: { list; }; create; list; owners: { list; }; settings: { info; setDefaultChannels; setDescription; setDiscoverability; setIcon; setName; }; }; usergroups: { addChannels; addTeams; listChannels; removeChannels; }; users: { assign; invite; list; remove; session: { list; reset; resetBulk; invalidate; getSettings; setSettings; clearSettings; }; unsupportedVersions: { export; }; setAdmin; setExpiration; setOwner; setRegular; }; workflows: { search; unpublish; collaborators: { add; remove; }; permissions: { lookup; }; }; }
readonly
api: { test; }
readonly
apps: { connections: { open; }; datastore: { put; update; get; query; delete; }; event: { authorizations: { list; }; }; manifest: { create; delete; update; export; validate; }; uninstall; }
readonly
auth: { revoke; teams: { list; }; test; }
readonly
bookmarks: { add; edit; list; remove; }
readonly
bots: { info; }
readonly
chat: { delete; deleteScheduledMessage; getPermalink; meMessage; postEphemeral; postMessage; scheduleMessage; scheduledMessages: { list; }; unfurl; update; }
readonly
conversations: { acceptSharedInvite; approveSharedInvite; archive; close; create; declineSharedInvite; history; info; invite; inviteShared; join; kick; leave; list; listConnectInvites; mark; members; open; rename; replies; setPurpose; setTopic; unarchive; }
readonly
dnd: { endDnd; endSnooze; info; setSnooze; teamInfo; }
readonly
emoji: { list; }
readonly
files: { delete; info; list; revokePublicURL; sharedPublicURL; upload; getUploadURLExternal; completeUploadExternal; remote: { info; list; add; update; remove; share; }; }
readonly
functions: { completeSuccess; completeError; }
readonly
migration: { exchange; }
readonly
oauth: { v2: { access; exchange; }; }
readonly
openid: { connect: { token; userInfo; }; }
readonly
pins: { add; list; remove; }
readonly
reactions: { add; get; list; remove; }
readonly
reminders: { add; complete; delete; info; list; }
readonly
stars: { add; list; remove; }
readonly
team: { accessLogs; billableInfo; billing: { info; }; info; integrationLogs; preferences: { list; }; profile: { get; }; }
readonly
tooling: { tokens: { rotate; }; }
readonly
usergroups: { create; disable; enable; list; update; users: { list; update; }; }
readonly
users: { conversations; deletePhoto; getPresence; identity; info; list; lookupByEmail; setPhoto; setPresence; profile: { get; set; }; }
readonly
views: { open; publish; push; update; }
readonly
workflows: { triggers: { create; update; delete; list; }; }

Methods

bindApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
bindMultipartApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
call(name: string, params: Record<string, any>): Promise<SlackAPIResponse>
sendMultipartData(name: string, params: Record<string, any>): Promise<SlackAPIResponse>

Constructors

new
SlackAPIClient(token?: string | undefined, options?: SlackAPIClientOptions)

Properties

readonly
admin: { apps: { approve; approved: { list; }; clearResolution; requests: { cancel; list; }; restrict; restricted: { list; }; uninstall; activities: { list; }; }; auth: { policy: { assignEntities; getEntities; removeEntities; }; }; barriers: { create; delete; list; update; }; conversations: { archive; bulkArchive; bulkDelete; bulkMove; convertToPrivate; convertToPublic; create; delete; disconnectShared; ekm: { listOriginalConnectedChannelInfo; }; getConversationPrefs; getTeams; invite; rename; restrictAccess: { addGroup; listGroups; removeGroup; }; getCustomRetention; setCustomRetention; removeCustomRetention; lookup; search; setConversationPrefs; setTeams; unarchive; }; emoji: { add; addAlias; list; remove; rename; }; functions: { list; permissions: { lookup; set; }; }; inviteRequests: { approve; approved: { list; }; denied: { list; }; deny; list; }; roles: { addAssignments; listAssignments; removeAssignments; }; teams: { admins: { list; }; create; list; owners: { list; }; settings: { info; setDefaultChannels; setDescription; setDiscoverability; setIcon; setName; }; }; usergroups: { addChannels; addTeams; listChannels; removeChannels; }; users: { assign; invite; list; remove; session: { list; reset; resetBulk; invalidate; getSettings; setSettings; clearSettings; }; unsupportedVersions: { export; }; setAdmin; setExpiration; setOwner; setRegular; }; workflows: { search; unpublish; collaborators: { add; remove; }; permissions: { lookup; }; }; }
readonly
api: { test; }
readonly
apps: { connections: { open; }; datastore: { put; update; get; query; delete; }; event: { authorizations: { list; }; }; manifest: { create; delete; update; export; validate; }; uninstall; }
readonly
auth: { revoke; teams: { list; }; test; }
readonly
bookmarks: { add; edit; list; remove; }
readonly
bots: { info; }
readonly
chat: { delete; deleteScheduledMessage; getPermalink; meMessage; postEphemeral; postMessage; scheduleMessage; scheduledMessages: { list; }; unfurl; update; }
readonly
conversations: { acceptSharedInvite; approveSharedInvite; archive; close; create; declineSharedInvite; history; info; invite; inviteShared; join; kick; leave; list; listConnectInvites; mark; members; open; rename; replies; setPurpose; setTopic; unarchive; }
readonly
dnd: { endDnd; endSnooze; info; setSnooze; teamInfo; }
readonly
emoji: { list; }
readonly
files: { delete; info; list; revokePublicURL; sharedPublicURL; upload; getUploadURLExternal; completeUploadExternal; remote: { info; list; add; update; remove; share; }; }
readonly
functions: { completeSuccess; completeError; }
readonly
migration: { exchange; }
readonly
oauth: { v2: { access; exchange; }; }
readonly
openid: { connect: { token; userInfo; }; }
readonly
pins: { add; list; remove; }
readonly
reactions: { add; get; list; remove; }
readonly
reminders: { add; complete; delete; info; list; }
readonly
stars: { add; list; remove; }
readonly
team: { accessLogs; billableInfo; billing: { info; }; info; integrationLogs; preferences: { list; }; profile: { get; }; }
readonly
tooling: { tokens: { rotate; }; }
readonly
usergroups: { create; disable; enable; list; update; users: { list; update; }; }
readonly
users: { conversations; deletePhoto; getPresence; identity; info; list; lookupByEmail; setPhoto; setPresence; profile: { get; set; }; }
readonly
views: { open; publish; push; update; }
readonly
workflows: { triggers: { create; update; delete; list; }; }

Methods

bindApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
bindMultipartApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
call(name: string, params: Record<string, any>): Promise<SlackAPIResponse>
sendMultipartData(name: string, params: Record<string, any>): Promise<SlackAPIResponse>

Constructors

new
SlackAPIClient(token?: string | undefined, options?: SlackAPIClientOptions)

Properties

readonly
admin: { apps: { approve; approved: { list; }; clearResolution; requests: { cancel; list; }; restrict; restricted: { list; }; uninstall; activities: { list; }; }; auth: { policy: { assignEntities; getEntities; removeEntities; }; }; barriers: { create; delete; list; update; }; conversations: { archive; bulkArchive; bulkDelete; bulkMove; convertToPrivate; convertToPublic; create; delete; disconnectShared; ekm: { listOriginalConnectedChannelInfo; }; getConversationPrefs; getTeams; invite; rename; restrictAccess: { addGroup; listGroups; removeGroup; }; getCustomRetention; setCustomRetention; removeCustomRetention; lookup; search; setConversationPrefs; setTeams; unarchive; }; emoji: { add; addAlias; list; remove; rename; }; functions: { list; permissions: { lookup; set; }; }; inviteRequests: { approve; approved: { list; }; denied: { list; }; deny; list; }; roles: { addAssignments; listAssignments; removeAssignments; }; teams: { admins: { list; }; create; list; owners: { list; }; settings: { info; setDefaultChannels; setDescription; setDiscoverability; setIcon; setName; }; }; usergroups: { addChannels; addTeams; listChannels; removeChannels; }; users: { assign; invite; list; remove; session: { list; reset; resetBulk; invalidate; getSettings; setSettings; clearSettings; }; unsupportedVersions: { export; }; setAdmin; setExpiration; setOwner; setRegular; }; workflows: { search; unpublish; collaborators: { add; remove; }; permissions: { lookup; }; }; }
readonly
api: { test; }
readonly
apps: { connections: { open; }; datastore: { put; update; get; query; delete; }; event: { authorizations: { list; }; }; manifest: { create; delete; update; export; validate; }; uninstall; }
readonly
auth: { revoke; teams: { list; }; test; }
readonly
bookmarks: { add; edit; list; remove; }
readonly
bots: { info; }
readonly
chat: { delete; deleteScheduledMessage; getPermalink; meMessage; postEphemeral; postMessage; scheduleMessage; scheduledMessages: { list; }; unfurl; update; }
readonly
conversations: { acceptSharedInvite; approveSharedInvite; archive; close; create; declineSharedInvite; history; info; invite; inviteShared; join; kick; leave; list; listConnectInvites; mark; members; open; rename; replies; setPurpose; setTopic; unarchive; }
readonly
dnd: { endDnd; endSnooze; info; setSnooze; teamInfo; }
readonly
emoji: { list; }
readonly
files: { delete; info; list; revokePublicURL; sharedPublicURL; upload; getUploadURLExternal; completeUploadExternal; remote: { info; list; add; update; remove; share; }; }
readonly
functions: { completeSuccess; completeError; }
readonly
migration: { exchange; }
readonly
oauth: { v2: { access; exchange; }; }
readonly
openid: { connect: { token; userInfo; }; }
readonly
pins: { add; list; remove; }
readonly
reactions: { add; get; list; remove; }
readonly
reminders: { add; complete; delete; info; list; }
readonly
stars: { add; list; remove; }
readonly
team: { accessLogs; billableInfo; billing: { info; }; info; integrationLogs; preferences: { list; }; profile: { get; }; }
readonly
tooling: { tokens: { rotate; }; }
readonly
usergroups: { create; disable; enable; list; update; users: { list; update; }; }
readonly
users: { conversations; deletePhoto; getPresence; identity; info; list; lookupByEmail; setPhoto; setPresence; profile: { get; set; }; }
readonly
views: { open; publish; push; update; }
readonly
workflows: { triggers: { create; update; delete; list; }; }

Methods

bindApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
bindMultipartApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
call(name: string, params: Record<string, any>): Promise<SlackAPIResponse>
sendMultipartData(name: string, params: Record<string, any>): Promise<SlackAPIResponse>

Constructors

new
SlackAPIClient(token?: string | undefined, options?: SlackAPIClientOptions)

Properties

readonly
admin: { apps: { approve; approved: { list; }; clearResolution; requests: { cancel; list; }; restrict; restricted: { list; }; uninstall; activities: { list; }; }; auth: { policy: { assignEntities; getEntities; removeEntities; }; }; barriers: { create; delete; list; update; }; conversations: { archive; bulkArchive; bulkDelete; bulkMove; convertToPrivate; convertToPublic; create; delete; disconnectShared; ekm: { listOriginalConnectedChannelInfo; }; getConversationPrefs; getTeams; invite; rename; restrictAccess: { addGroup; listGroups; removeGroup; }; getCustomRetention; setCustomRetention; removeCustomRetention; lookup; search; setConversationPrefs; setTeams; unarchive; }; emoji: { add; addAlias; list; remove; rename; }; functions: { list; permissions: { lookup; set; }; }; inviteRequests: { approve; approved: { list; }; denied: { list; }; deny; list; }; roles: { addAssignments; listAssignments; removeAssignments; }; teams: { admins: { list; }; create; list; owners: { list; }; settings: { info; setDefaultChannels; setDescription; setDiscoverability; setIcon; setName; }; }; usergroups: { addChannels; addTeams; listChannels; removeChannels; }; users: { assign; invite; list; remove; session: { list; reset; resetBulk; invalidate; getSettings; setSettings; clearSettings; }; unsupportedVersions: { export; }; setAdmin; setExpiration; setOwner; setRegular; }; workflows: { search; unpublish; collaborators: { add; remove; }; permissions: { lookup; }; }; }
readonly
api: { test; }
readonly
apps: { connections: { open; }; datastore: { put; update; get; query; delete; }; event: { authorizations: { list; }; }; manifest: { create; delete; update; export; validate; }; uninstall; }
readonly
auth: { revoke; teams: { list; }; test; }
readonly
bookmarks: { add; edit; list; remove; }
readonly
bots: { info; }
readonly
chat: { delete; deleteScheduledMessage; getPermalink; meMessage; postEphemeral; postMessage; scheduleMessage; scheduledMessages: { list; }; unfurl; update; }
readonly
conversations: { acceptSharedInvite; approveSharedInvite; archive; close; create; declineSharedInvite; history; info; invite; inviteShared; join; kick; leave; list; listConnectInvites; mark; members; open; rename; replies; setPurpose; setTopic; unarchive; }
readonly
dnd: { endDnd; endSnooze; info; setSnooze; teamInfo; }
readonly
emoji: { list; }
readonly
files: { delete; info; list; revokePublicURL; sharedPublicURL; upload; getUploadURLExternal; completeUploadExternal; remote: { info; list; add; update; remove; share; }; }
readonly
functions: { completeSuccess; completeError; }
readonly
migration: { exchange; }
readonly
oauth: { v2: { access; exchange; }; }
readonly
openid: { connect: { token; userInfo; }; }
readonly
pins: { add; list; remove; }
readonly
reactions: { add; get; list; remove; }
readonly
reminders: { add; complete; delete; info; list; }
readonly
stars: { add; list; remove; }
readonly
team: { accessLogs; billableInfo; billing: { info; }; info; integrationLogs; preferences: { list; }; profile: { get; }; }
readonly
tooling: { tokens: { rotate; }; }
readonly
usergroups: { create; disable; enable; list; update; users: { list; update; }; }
readonly
users: { conversations; deletePhoto; getPresence; identity; info; list; lookupByEmail; setPhoto; setPresence; profile: { get; set; }; }
readonly
views: { open; publish; push; update; }
readonly
workflows: { triggers: { create; update; delete; list; }; }

Methods

bindApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
bindMultipartApiCall<A extends SlackAPIRequest, R extends SlackAPIResponse>(self: SlackAPIClient, method: string): SlackAPI<A, R>
call(name: string, params: Record<string, any>): Promise<SlackAPIResponse>
sendMultipartData(name: string, params: Record<string, any>): Promise<SlackAPIResponse>