Class: Slackened::Methods

Inherits:
Object
  • Object
show all
Defined in:
lib/slackened/methods.rb

Constant Summary collapse

METHODS =
{
	'admin.analytics.getFile' => {
		path: '/admin.analytics.getFile',
		desc: 'Retrieve analytics data for a given date, presented as a compressed JSON file'
	},
	'admin.apps.activities.list' => {
		path: '/admin.apps.activities.list',
		desc: 'Get logs for a specified team/org'
	},
	'admin.apps.approve' => {
		path: '/admin.apps.approve',
		desc: 'Approve an app for installation on a workspace.'
	},
	'admin.apps.clearResolution' => {
		path: '/admin.apps.clearResolution',
		desc: 'Clear an app resolution'
	},
	'admin.apps.restrict' => {
		path: '/admin.apps.restrict',
		desc: 'Restrict an app for installation on a workspace.'
	},
	'admin.apps.uninstall' => {
		path: '/admin.apps.uninstall',
		desc: 'Uninstall an app from one or many workspaces, or an entire enterprise organization.'
	},
	'admin.apps.approved.list' => {
		path: '/admin.apps.approved.list',
		desc: 'List approved apps for an org or workspace.'
	},
	'admin.apps.config.lookup' => {
		path: '/admin.apps.config.lookup',
		desc: 'Look up the app config for connectors by their IDs'
	},
	'admin.apps.config.set' => {
		path: '/admin.apps.config.set',
		desc: 'Set the app config for a connector'
	},
	'admin.apps.requests.cancel' => {
		path: '/admin.apps.requests.cancel',
		desc: 'Cancel app request for team'
	},
	'admin.apps.requests.list' => {
		path: '/admin.apps.requests.list',
		desc: 'List app requests for a team/workspace.'
	},
	'admin.apps.restricted.list' => {
		path: '/admin.apps.restricted.list',
		desc: 'List restricted apps for an org or workspace.'
	},
	'admin.audit.anomaly.allow.getItem' => {
		path: '/admin.audit.anomaly.allow.getItem',
		desc: 'API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
	},
	'admin.audit.anomaly.allow.updateItem' => {
		path: '/admin.audit.anomaly.allow.updateItem',
		desc: 'API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
	},
	'admin.auth.policy.assignEntities' => {
		path: '/admin.auth.policy.assignEntities',
		desc: 'Assign entities to a particular authentication policy.'
	},
	'admin.auth.policy.getEntities' => {
		path: '/admin.auth.policy.getEntities',
		desc: 'Fetch all the entities assigned to a particular authentication policy by name.'
	},
	'admin.auth.policy.removeEntities' => {
		path: '/admin.auth.policy.removeEntities',
		desc: 'Remove specified entities from a specified authentication policy.'
	},
	'admin.barriers.create' => {
		path: '/admin.barriers.create',
		desc: 'Create an Information Barrier'
	},
	'admin.barriers.delete' => {
		path: '/admin.barriers.delete',
		desc: 'Delete an existing Information Barrier'
	},
	'admin.barriers.list' => {
		path: '/admin.barriers.list',
		desc: 'Get all Information Barriers for your organization'
	},
	'admin.barriers.update' => {
		path: '/admin.barriers.update',
		desc: 'Update an existing Information Barrier'
	},
	'admin.conversations.archive' => {
		path: '/admin.conversations.archive',
		desc: 'Archive a public or private channel.'
	},
	'admin.conversations.bulkArchive' => {
		path: '/admin.conversations.bulkArchive',
		desc: 'Archive public or private channels in bulk.'
	},
	'admin.conversations.bulkDelete' => {
		path: '/admin.conversations.bulkDelete',
		desc: 'Delete public or private channels in bulk'
	},
	'admin.conversations.bulkMove' => {
		path: '/admin.conversations.bulkMove',
		desc: 'Move public or private channels in bulk.'
	},
	'admin.conversations.convertToPrivate' => {
		path: '/admin.conversations.convertToPrivate',
		desc: 'Convert a public channel to a private channel.'
	},
	'admin.conversations.convertToPublic' => {
		path: '/admin.conversations.convertToPublic',
		desc: 'Convert a private channel to a public channel.'
	},
	'admin.conversations.create' => {
		path: '/admin.conversations.create',
		desc: 'Create a public or private channel-based conversation.'
	},
	'admin.conversations.delete' => {
		path: '/admin.conversations.delete',
		desc: 'Delete a public or private channel.'
	},
	'admin.conversations.disconnectShared' => {
		path: '/admin.conversations.disconnectShared',
		desc: 'Disconnect a connected channel from one or more workspaces.'
	},
	'admin.conversations.getConversationPrefs' => {
		path: '/admin.conversations.getConversationPrefs',
		desc: 'Get conversation preferences for a public or private channel.'
	},
	'admin.conversations.getCustomRetention' => {
		path: '/admin.conversations.getCustomRetention',
		desc: 'This API endpoint can be used by any admin to get a conversation\'s retention policy.'
	},
	'admin.conversations.getTeams' => {
		path: '/admin.conversations.getTeams',
		desc: 'Get all the workspaces a given public or private channel is connected to within this Enterprise org.'
	},
	'admin.conversations.invite' => {
		path: '/admin.conversations.invite',
		desc: 'Invite a user to a public or private channel.'
	},
	'admin.conversations.lookup' => {
		path: '/admin.conversations.lookup',
		desc: 'Returns channels on the given team using the filters.'
	},
	'admin.conversations.removeCustomRetention' => {
		path: '/admin.conversations.removeCustomRetention',
		desc: 'This API endpoint can be used by any admin to remove a conversation\'s retention policy.'
	},
	'admin.conversations.rename' => {
		path: '/admin.conversations.rename',
		desc: 'Rename a public or private channel.'
	},
	'admin.conversations.search' => {
		path: '/admin.conversations.search',
		desc: 'Search for public or private channels in an Enterprise organization.'
	},
	'admin.conversations.setConversationPrefs' => {
		path: '/admin.conversations.setConversationPrefs',
		desc: 'Set the posting permissions for a public or private channel.'
	},
	'admin.conversations.setCustomRetention' => {
		path: '/admin.conversations.setCustomRetention',
		desc: 'This API endpoint can be used by any admin to set a conversation\'s retention policy.'
	},
	'admin.conversations.setTeams' => {
		path: '/admin.conversations.setTeams',
		desc: 'Set the workspaces in an Enterprise grid org that connect to a public or private channel.'
	},
	'admin.conversations.unarchive' => {
		path: '/admin.conversations.unarchive',
		desc: 'Unarchive a public or private channel.'
	},
	'admin.conversations.ekm.listOriginalConnectedChannelInfo' => {
		path: '/admin.conversations.ekm.listOriginalConnectedChannelInfo',
		desc: '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.'
	},
	'admin.conversations.restrictAccess.addGroup' => {
		path: '/admin.conversations.restrictAccess.addGroup',
		desc: 'Add an allowlist of IDP groups for accessing a channel'
	},
	'admin.conversations.restrictAccess.listGroups' => {
		path: '/admin.conversations.restrictAccess.listGroups',
		desc: 'List all IDP Groups linked to a channel'
	},
	'admin.conversations.restrictAccess.removeGroup' => {
		path: '/admin.conversations.restrictAccess.removeGroup',
		desc: 'Remove a linked IDP group linked from a private channel'
	},
	'admin.emoji.add' => {
		path: '/admin.emoji.add',
		desc: 'Add an emoji.'
	},
	'admin.emoji.addAlias' => {
		path: '/admin.emoji.addAlias',
		desc: 'Add an emoji alias.'
	},
	'admin.emoji.list' => {
		path: '/admin.emoji.list',
		desc: 'List emoji for an Enterprise Grid organization.'
	},
	'admin.emoji.remove' => {
		path: '/admin.emoji.remove',
		desc: 'Remove an emoji across an Enterprise Grid organization'
	},
	'admin.emoji.rename' => {
		path: '/admin.emoji.rename',
		desc: 'Rename an emoji.'
	},
	'admin.functions.list' => {
		path: '/admin.functions.list',
		desc: 'Look up functions by a set of apps'
	},
	'admin.functions.permissions.lookup' => {
		path: '/admin.functions.permissions.lookup',
		desc: 'Lookup the visibility of multiple Slack functions and include the users if it is limited to particular named entities.'
	},
	'admin.functions.permissions.set' => {
		path: '/admin.functions.permissions.set',
		desc: 'Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities'
	},
	'admin.inviteRequests.approve' => {
		path: '/admin.inviteRequests.approve',
		desc: 'Approve a workspace invite request.'
	},
	'admin.inviteRequests.deny' => {
		path: '/admin.inviteRequests.deny',
		desc: 'Deny a workspace invite request.'
	},
	'admin.inviteRequests.list' => {
		path: '/admin.inviteRequests.list',
		desc: 'List all pending workspace invite requests.'
	},
	'admin.inviteRequests.approved.list' => {
		path: '/admin.inviteRequests.approved.list',
		desc: 'List all approved workspace invite requests.'
	},
	'admin.inviteRequests.denied.list' => {
		path: '/admin.inviteRequests.denied.list',
		desc: 'List all denied workspace invite requests.'
	},
	'admin.roles.addAssignments' => {
		path: '/admin.roles.addAssignments',
		desc: 'Adds members to the specified role with the specified scopes'
	},
	'admin.roles.listAssignments' => {
		path: '/admin.roles.listAssignments',
		desc: 'Lists assignments for all roles across entities. Options to scope results by any combination of roles or entities'
	},
	'admin.roles.removeAssignments' => {
		path: '/admin.roles.removeAssignments',
		desc: 'Removes a set of users from a role for the given scopes and entities'
	},
	'admin.teams.admins.list' => {
		path: '/admin.teams.admins.list',
		desc: 'List all of the admins on a given workspace.'
	},
	'admin.teams.create' => {
		path: '/admin.teams.create',
		desc: 'Create an Enterprise team.'
	},
	'admin.teams.list' => {
		path: '/admin.teams.list',
		desc: 'List all teams on an Enterprise organization'
	},
	'admin.teams.owners.list' => {
		path: '/admin.teams.owners.list',
		desc: 'List all of the owners on a given workspace.'
	},
	'admin.teams.settings.info' => {
		path: '/admin.teams.settings.info',
		desc: 'Fetch information about settings in a workspace'
	},
	'admin.teams.settings.setDefaultChannels' => {
		path: '/admin.teams.settings.setDefaultChannels',
		desc: 'Set the default channels of a workspace.'
	},
	'admin.teams.settings.setDescription' => {
		path: '/admin.teams.settings.setDescription',
		desc: 'Set the description of a given workspace.'
	},
	'admin.teams.settings.setDiscoverability' => {
		path: '/admin.teams.settings.setDiscoverability',
		desc: 'An API path that allows admins to set the discoverability of a given workspace'
	},
	'admin.teams.settings.setIcon' => {
		path: '/admin.teams.settings.setIcon',
		desc: 'Sets the icon of a workspace.'
	},
	'admin.teams.settings.setName' => {
		path: '/admin.teams.settings.setName',
		desc: 'Set the name of a given workspace.'
	},
	'admin.usergroups.addChannels' => {
		path: '/admin.usergroups.addChannels',
		desc: 'Add up to one hundred default channels to an IDP group.'
	},
	'admin.usergroups.addTeams' => {
		path: '/admin.usergroups.addTeams',
		desc: 'Associate one or more default workspaces with an organization-wide IDP group.'
	},
	'admin.usergroups.listChannels' => {
		path: '/admin.usergroups.listChannels',
		desc: 'List the channels linked to an org-level IDP group (user group).'
	},
	'admin.usergroups.removeChannels' => {
		path: '/admin.usergroups.removeChannels',
		desc: 'Remove one or more default channels from an org-level IDP group (user group).'
	},
	'admin.users.assign' => {
		path: '/admin.users.assign',
		desc: 'Add an Enterprise user to a workspace.'
	},
	'admin.users.invite' => {
		path: '/admin.users.invite',
		desc: 'Invite a user to a workspace.'
	},
	'admin.users.list' => {
		path: '/admin.users.list',
		desc: 'List users on a workspace'
	},
	'admin.users.remove' => {
		path: '/admin.users.remove',
		desc: 'Remove a user from a workspace.'
	},
	'admin.users.setAdmin' => {
		path: '/admin.users.setAdmin',
		desc: 'Set an existing regular user or owner to be a workspace admin.'
	},
	'admin.users.setExpiration' => {
		path: '/admin.users.setExpiration',
		desc: 'Set an expiration for a guest user'
	},
	'admin.users.setOwner' => {
		path: '/admin.users.setOwner',
		desc: 'Set an existing regular user or admin to be a workspace owner.'
	},
	'admin.users.setRegular' => {
		path: '/admin.users.setRegular',
		desc: 'Set an existing guest user, admin user, or owner to be a regular user.'
	},
	'admin.users.session.clearSettings' => {
		path: '/admin.users.session.clearSettings',
		desc: 'Clear user-specific session settings—the session duration and what happens when the client closes—for a list of users.'
	},
	'admin.users.session.getSettings' => {
		path: '/admin.users.session.getSettings',
		desc: 'Get user-specific session settings—the session duration and what happens when the client closes—given a list of users.'
	},
	'admin.users.session.invalidate' => {
		path: '/admin.users.session.invalidate',
		desc: 'Revoke a single session for a user. The user will be forced to login to Slack.'
	},
	'admin.users.session.list' => {
		path: '/admin.users.session.list',
		desc: 'List active user sessions for an organization'
	},
	'admin.users.session.reset' => {
		path: '/admin.users.session.reset',
		desc: 'Wipes all valid sessions on all devices for a given user'
	},
	'admin.users.session.resetBulk' => {
		path: '/admin.users.session.resetBulk',
		desc: 'Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users'
	},
	'admin.users.session.setSettings' => {
		path: '/admin.users.session.setSettings',
		desc: 'Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.'
	},
	'admin.users.unsupportedVersions.export' => {
		path: '/admin.users.unsupportedVersions.export',
		desc: 'Ask Slackbot to send you an export listing all workspace members using unsupported software, presented as a zipped CSV file.'
	},
	'admin.workflows.collaborators.add' => {
		path: '/admin.workflows.collaborators.add',
		desc: 'Add collaborators to workflows within the team or enterprise'
	},
	'admin.workflows.collaborators.remove' => {
		path: '/admin.workflows.collaborators.remove',
		desc: 'Remove collaborators from workflows within the team or enterprise'
	},
	'admin.workflows.permissions.lookup' => {
		path: '/admin.workflows.permissions.lookup',
		desc: 'Look up the permissions for a set of workflows'
	},
	'admin.workflows.search' => {
		path: '/admin.workflows.search',
		desc: 'Search workflows within the team or enterprise'
	},
	'admin.workflows.unpublish' => {
		path: '/admin.workflows.unpublish',
		desc: 'Unpublish workflows within the team or enterprise'
	},
	'admin.workflows.triggers.types.permissions.lookup' => {
		path: '/admin.workflows.triggers.types.permissions.lookup',
		desc: 'list the permissions for using each trigger type in workflow builder'
	},
	'admin.workflows.triggers.types.permissions.set' => {
		path: '/admin.workflows.triggers.types.permissions.set',
		desc: 'Set the permissions for using a trigger type in workflow builder'
	},
	'api.test' => {
		path: '/api.test',
		desc: 'Checks API calling code.'
	},
	'apps.activities.list' => {
		path: '/apps.activities.list',
		desc: 'Get logs for a specified app'
	},
	'apps.auth.external.delete' => {
		path: '/apps.auth.external.delete',
		desc: 'Delete external auth tokens only on the Slack side'
	},
	'apps.auth.external.get' => {
		path: '/apps.auth.external.get',
		desc: 'Get the access token for the provided token ID'
	},
	'apps.connections.open' => {
		path: '/apps.connections.open',
		desc: 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over.'
	},
	'apps.datastore.bulkDelete' => {
		path: '/apps.datastore.bulkDelete',
		desc: 'Delete items from a datastore in bulk'
	},
	'apps.datastore.bulkGet' => {
		path: '/apps.datastore.bulkGet',
		desc: 'Get items from a datastore in bulk'
	},
	'apps.datastore.bulkPut' => {
		path: '/apps.datastore.bulkPut',
		desc: 'Creates or replaces existing items in bulk'
	},
	'apps.datastore.count' => {
		path: '/apps.datastore.count',
		desc: 'Count the number of items in a datastore that match a query'
	},
	'apps.datastore.delete' => {
		path: '/apps.datastore.delete',
		desc: 'Delete an item from a datastore'
	},
	'apps.datastore.get' => {
		path: '/apps.datastore.get',
		desc: 'Get an item from a datastore'
	},
	'apps.datastore.put' => {
		path: '/apps.datastore.put',
		desc: 'Creates a new item, or replaces an old item with a new item.'
	},
	'apps.datastore.query' => {
		path: '/apps.datastore.query',
		desc: 'Query a datastore for items'
	},
	'apps.datastore.update' => {
		path: '/apps.datastore.update',
		desc: 'Edits an existing item\'s attributes, or adds a new item if it does not already exist.'
	},
	'apps.event.authorizations.list' => {
		path: '/apps.event.authorizations.list',
		desc: 'Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.'
	},
	'apps.manifest.create' => {
		path: '/apps.manifest.create',
		desc: 'Create an app from an app manifest.'
	},
	'apps.manifest.delete' => {
		path: '/apps.manifest.delete',
		desc: 'Permanently deletes an app created through app manifests'
	},
	'apps.manifest.export' => {
		path: '/apps.manifest.export',
		desc: 'Export an app manifest from an existing app'
	},
	'apps.manifest.update' => {
		path: '/apps.manifest.update',
		desc: 'Update an app from an app manifest'
	},
	'apps.manifest.validate' => {
		path: '/apps.manifest.validate',
		desc: 'Validate an app manifest'
	},
	'apps.uninstall' => {
		path: '/apps.uninstall',
		desc: 'Uninstalls your app from a workspace.'
	},
	'auth.revoke' => {
		path: '/auth.revoke',
		desc: 'Revokes a token.'
	},
	'auth.test' => {
		path: '/auth.test',
		desc: 'Checks authentication & identity.'
	},
	'auth.teams.list' => {
		path: '/auth.teams.list',
		desc: 'Obtain a full list of workspaces your org-wide app has been approved for.'
	},
	'bookmarks.add' => {
		path: '/bookmarks.add',
		desc: 'Add bookmark to a channel.'
	},
	'bookmarks.edit' => {
		path: '/bookmarks.edit',
		desc: 'Edit bookmark.'
	},
	'bookmarks.list' => {
		path: '/bookmarks.list',
		desc: 'List bookmark for the channel.'
	},
	'bookmarks.remove' => {
		path: '/bookmarks.remove',
		desc: 'Remove bookmark from the channel.'
	},
	'bots.info' => {
		path: '/bots.info',
		desc: 'Gets information about a bot user.'
	},
	'calls.add' => {
		path: '/calls.add',
		desc: 'Registers a new Call.'
	},
	'calls.end' => {
		path: '/calls.end',
		desc: 'Ends a Call.'
	},
	'calls.info' => {
		path: '/calls.info',
		desc: 'Returns information about a Call.'
	},
	'calls.update' => {
		path: '/calls.update',
		desc: 'Updates information about a Call.'
	},
	'calls.participants.add' => {
		path: '/calls.participants.add',
		desc: 'Registers new participants added to a Call.'
	},
	'calls.participants.remove' => {
		path: '/calls.participants.remove',
		desc: 'Registers participants removed from a Call.'
	},
	'canvases.access.delete' => {
		path: '/canvases.access.delete',
		desc: 'Remove access to a canvas for specified entities'
	},
	'canvases.access.set' => {
		path: '/canvases.access.set',
		desc: 'Sets the access level to a canvas for specified entities'
	},
	'canvases.create' => {
		path: '/canvases.create',
		desc: 'Create Canvas for a user.'
	},
	'canvases.delete' => {
		path: '/canvases.delete',
		desc: 'Deletes a canvas.'
	},
	'canvases.edit' => {
		path: '/canvases.edit',
		desc: 'Update an existing canvas'
	},
	'canvases.sections.lookup' => {
		path: '/canvases.sections.lookup',
		desc: 'Find sections matching the provided criteria'
	},
	'chat.delete' => {
		path: '/chat.delete',
		desc: 'Deletes a message.'
	},
	'chat.deleteScheduledMessage' => {
		path: '/chat.deleteScheduledMessage',
		desc: 'Deletes a pending scheduled message from the queue.'
	},
	'chat.getPermalink' => {
		path: '/chat.getPermalink',
		desc: 'Retrieve a permalink URL for a specific extant message'
	},
	'chat.meMessage' => {
		path: '/chat.meMessage',
		desc: 'Share a me message into a channel.'
	},
	'chat.postEphemeral' => {
		path: '/chat.postEphemeral',
		desc: 'Sends an ephemeral message to a user in a channel.'
	},
	'chat.postMessage' => {
		path: '/chat.postMessage',
		desc: 'Sends a message to a channel.'
	},
	'chat.scheduleMessage' => {
		path: '/chat.scheduleMessage',
		desc: 'Schedules a message to be sent to a channel.'
	},
	'chat.unfurl' => {
		path: '/chat.unfurl',
		desc: 'Provide custom unfurl behavior for user-posted URLs'
	},
	'chat.update' => {
		path: '/chat.update',
		desc: 'Updates a message.'
	},
	'chat.scheduledMessages.list' => {
		path: '/chat.scheduledMessages.list',
		desc: 'Returns a list of scheduled messages.'
	},
	'conversations.acceptSharedInvite' => {
		path: '/conversations.acceptSharedInvite',
		desc: 'Accepts an invitation to a Slack Connect channel.'
	},
	'conversations.approveSharedInvite' => {
		path: '/conversations.approveSharedInvite',
		desc: 'Approves an invitation to a Slack Connect channel'
	},
	'conversations.archive' => {
		path: '/conversations.archive',
		desc: 'Archives a conversation.'
	},
	'conversations.close' => {
		path: '/conversations.close',
		desc: 'Closes a direct message or multi-person direct message.'
	},
	'conversations.create' => {
		path: '/conversations.create',
		desc: 'Initiates a public or private channel-based conversation'
	},
	'conversations.declineSharedInvite' => {
		path: '/conversations.declineSharedInvite',
		desc: 'Declines a Slack Connect channel invite.'
	},
	'conversations.history' => {
		path: '/conversations.history',
		desc: 'Fetches a conversation\'s history of messages and events.'
	},
	'conversations.info' => {
		path: '/conversations.info',
		desc: 'Retrieve information about a conversation.'
	},
	'conversations.invite' => {
		path: '/conversations.invite',
		desc: 'Invites users to a channel.'
	},
	'conversations.inviteShared' => {
		path: '/conversations.inviteShared',
		desc: 'Sends an invitation to a Slack Connect channel'
	},
	'conversations.join' => {
		path: '/conversations.join',
		desc: 'Joins an existing conversation.'
	},
	'conversations.kick' => {
		path: '/conversations.kick',
		desc: 'Removes a user from a conversation.'
	},
	'conversations.leave' => {
		path: '/conversations.leave',
		desc: 'Leaves a conversation.'
	},
	'conversations.list' => {
		path: '/conversations.list',
		desc: 'Lists all channels in a Slack team.'
	},
	'conversations.listConnectInvites' => {
		path: '/conversations.listConnectInvites',
		desc: 'Lists shared channel invites that have been generated or received but have not been approved by all parties'
	},
	'conversations.mark' => {
		path: '/conversations.mark',
		desc: 'Sets the read cursor in a channel.'
	},
	'conversations.members' => {
		path: '/conversations.members',
		desc: 'Retrieve members of a conversation.'
	},
	'conversations.open' => {
		path: '/conversations.open',
		desc: 'Opens or resumes a direct message or multi-person direct message.'
	},
	'conversations.rename' => {
		path: '/conversations.rename',
		desc: 'Renames a conversation.'
	},
	'conversations.replies' => {
		path: '/conversations.replies',
		desc: 'Retrieve a thread of messages posted to a conversation'
	},
	'conversations.setPurpose' => {
		path: '/conversations.setPurpose',
		desc: 'Sets the purpose for a conversation.'
	},
	'conversations.setTopic' => {
		path: '/conversations.setTopic',
		desc: 'Sets the topic for a conversation.'
	},
	'conversations.unarchive' => {
		path: '/conversations.unarchive',
		desc: 'Reverses conversation archival.'
	},
	'conversations.canvases.create' => {
		path: '/conversations.canvases.create',
		desc: 'Create a Channel Canvas for a channel.'
	},
	'conversations.externalInvitePermissions.set' => {
		path: '/conversations.externalInvitePermissions.set',
		desc: 'Upgrade or downgrade Slack Connect channel permissions between \'can post only\' and \'can post and invite\'.'
	},
	'dialog.open' => {
		path: '/dialog.open',
		desc: 'Open a dialog with a user'
	},
	'dnd.endDnd' => {
		path: '/dnd.endDnd',
		desc: 'Ends the current user\'s Do Not Disturb session immediately.'
	},
	'dnd.endSnooze' => {
		path: '/dnd.endSnooze',
		desc: 'Ends the current user\'s snooze mode immediately.'
	},
	'dnd.info' => {
		path: '/dnd.info',
		desc: 'Retrieves a user\'s current Do Not Disturb status.'
	},
	'dnd.setSnooze' => {
		path: '/dnd.setSnooze',
		desc: 'Turns on Do Not Disturb mode for the current user, or changes its duration.'
	},
	'dnd.teamInfo' => {
		path: '/dnd.teamInfo',
		desc: 'Retrieves the Do Not Disturb status for up to 50 users on a team.'
	},
	'emoji.list' => {
		path: '/emoji.list',
		desc: 'Lists custom emoji for a team.'
	},
	'files.comments.delete' => {
		path: '/files.comments.delete',
		desc: 'Deletes an existing comment on a file.'
	},
	'files.completeUploadExternal' => {
		path: '/files.completeUploadExternal',
		desc: 'Finishes an upload started with files.getUploadURLExternal'
	},
	'files.delete' => {
		path: '/files.delete',
		desc: 'Deletes a file.'
	},
	'files.getUploadURLExternal' => {
		path: '/files.getUploadURLExternal',
		desc: 'Gets a URL for an edge external file upload'
	},
	'files.info' => {
		path: '/files.info',
		desc: 'Gets information about a file.'
	},
	'files.list' => {
		path: '/files.list',
		desc: 'List for a team, in a channel, or from a user with applied filters.'
	},
	'files.revokePublicURL' => {
		path: '/files.revokePublicURL',
		desc: 'Revokes public/external sharing access for a file'
	},
	'files.sharedPublicURL' => {
		path: '/files.sharedPublicURL',
		desc: 'Enables a file for public/external sharing.'
	},
	'files.upload' => {
		path: '/files.upload',
		desc: 'Uploads or creates a file.'
	},
	'files.remote.add' => {
		path: '/files.remote.add',
		desc: 'Adds a file from a remote service'
	},
	'files.remote.info' => {
		path: '/files.remote.info',
		desc: 'Retrieve information about a remote file added to Slack'
	},
	'files.remote.list' => {
		path: '/files.remote.list',
		desc: 'Retrieve information about a remote file added to Slack'
	},
	'files.remote.remove' => {
		path: '/files.remote.remove',
		desc: 'Remove a remote file.'
	},
	'files.remote.share' => {
		path: '/files.remote.share',
		desc: 'Share a remote file into a channel.'
	},
	'files.remote.update' => {
		path: '/files.remote.update',
		desc: 'Updates an existing remote file.'
	},
	'functions.completeError' => {
		path: '/functions.completeError',
		desc: 'Signal that a function failed to complete'
	},
	'functions.completeSuccess' => {
		path: '/functions.completeSuccess',
		desc: 'Signal the successful completion of a function'
	},
	'functions.distributions.permissions.add' => {
		path: '/functions.distributions.permissions.add',
		desc: 'Grant users access to a custom slack function if its permission_type is set to named_entities'
	},
	'functions.distributions.permissions.list' => {
		path: '/functions.distributions.permissions.list',
		desc: 'List the access type of a custom slack function and include the users with access if its permission_type is set to named_entities'
	},
	'functions.distributions.permissions.remove' => {
		path: '/functions.distributions.permissions.remove',
		desc: 'Revoke user access to a custom slack function if permission_type set to named_entities'
	},
	'functions.distributions.permissions.set' => {
		path: '/functions.distributions.permissions.set',
		desc: 'Set the access type of a custom slack function and define the users to be granted access if permission_type is set to named_entities'
	},
	'functions.workflows.steps.list' => {
		path: '/functions.workflows.steps.list',
		desc: 'List the steps of a specific function of a workflow\'s versions'
	},
	'functions.workflows.steps.responses.export' => {
		path: '/functions.workflows.steps.responses.export',
		desc: 'Download form responses of a workflow'
	},
	'migration.exchange' => {
		path: '/migration.exchange',
		desc: 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
	},
	'oauth.access' => {
		path: '/oauth.access',
		desc: 'Exchanges a temporary OAuth verifier code for an access token.'
	},
	'oauth.v2.access' => {
		path: '/oauth.v2.access',
		desc: 'Exchanges a temporary OAuth verifier code for an access token.'
	},
	'oauth.v2.exchange' => {
		path: '/oauth.v2.exchange',
		desc: 'Exchanges a legacy access token for a new expiring access token and refresh token'
	},
	'openid.connect.token' => {
		path: '/openid.connect.token',
		desc: 'Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.'
	},
	'openid.connect.userInfo' => {
		path: '/openid.connect.userInfo',
		desc: 'Get the identity of a user who has authorized Sign in with Slack.'
	},
	'pins.add' => {
		path: '/pins.add',
		desc: 'Pins an item to a channel.'
	},
	'pins.list' => {
		path: '/pins.list',
		desc: 'Lists items pinned to a channel.'
	},
	'pins.remove' => {
		path: '/pins.remove',
		desc: 'Un-pins an item from a channel.'
	},
	'reactions.add' => {
		path: '/reactions.add',
		desc: 'Adds a reaction to an item.'
	},
	'reactions.get' => {
		path: '/reactions.get',
		desc: 'Gets reactions for an item.'
	},
	'reactions.list' => {
		path: '/reactions.list',
		desc: 'Lists reactions made by a user.'
	},
	'reactions.remove' => {
		path: '/reactions.remove',
		desc: 'Removes a reaction from an item.'
	},
	'reminders.add' => {
		path: '/reminders.add',
		desc: 'Creates a reminder.'
	},
	'reminders.complete' => {
		path: '/reminders.complete',
		desc: 'Marks a reminder as complete.'
	},
	'reminders.delete' => {
		path: '/reminders.delete',
		desc: 'Deletes a reminder.'
	},
	'reminders.info' => {
		path: '/reminders.info',
		desc: 'Gets information about a reminder.'
	},
	'reminders.list' => {
		path: '/reminders.list',
		desc: 'Lists all reminders created by or for a given user.'
	},
	'rtm.connect' => {
		path: '/rtm.connect',
		desc: 'Starts a Real Time Messaging session.'
	},
	'rtm.start' => {
		path: '/rtm.start',
		desc: 'Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.'
	},
	'search.all' => {
		path: '/search.all',
		desc: 'Searches for messages and files matching a query.'
	},
	'search.files' => {
		path: '/search.files',
		desc: 'Searches for files matching a query.'
	},
	'search.messages' => {
		path: '/search.messages',
		desc: 'Searches for messages matching a query.'
	},
	'stars.add' => {
		path: '/stars.add',
		desc: 'Save an item for later. Formerly known as adding a star.'
	},
	'stars.list' => {
		path: '/stars.list',
		desc: 'Listed a user\'s saved items, formerly known as stars.'
	},
	'stars.remove' => {
		path: '/stars.remove',
		desc: 'Removes a saved item (star) from an item.'
	},
	'team.accessLogs' => {
		path: '/team.accessLogs',
		desc: 'Gets the access logs for the current team.'
	},
	'team.billableInfo' => {
		path: '/team.billableInfo',
		desc: 'Gets billable users information for the current team.'
	},
	'team.info' => {
		path: '/team.info',
		desc: 'Gets information about the current team.'
	},
	'team.integrationLogs' => {
		path: '/team.integrationLogs',
		desc: 'Gets the integration logs for the current team.'
	},
	'team.billing.info' => {
		path: '/team.billing.info',
		desc: 'Reads a workspace\'s billing plan information.'
	},
	'team.externalTeams.disconnect' => {
		path: '/team.externalTeams.disconnect',
		desc: 'Disconnect an external organization.'
	},
	'team.externalTeams.list' => {
		path: '/team.externalTeams.list',
		desc: 'Returns a list of all the external teams connected and details about the connection.'
	},
	'team.preferences.list' => {
		path: '/team.preferences.list',
		desc: 'Retrieve a list of a workspace\'s team preferences.'
	},
	'team.profile.get' => {
		path: '/team.profile.get',
		desc: 'Retrieve a team\'s profile.'
	},
	'tooling.tokens.rotate' => {
		path: '/tooling.tokens.rotate',
		desc: 'Exchanges a refresh token for a new app configuration token.'
	},
	'usergroups.create' => {
		path: '/usergroups.create',
		desc: 'Create a User Group.'
	},
	'usergroups.disable' => {
		path: '/usergroups.disable',
		desc: 'Disable an existing User Group.'
	},
	'usergroups.enable' => {
		path: '/usergroups.enable',
		desc: 'Enable a User Group.'
	},
	'usergroups.list' => {
		path: '/usergroups.list',
		desc: 'List all User Groups for a team.'
	},
	'usergroups.update' => {
		path: '/usergroups.update',
		desc: 'Update an existing User Group.'
	},
	'usergroups.users.list' => {
		path: '/usergroups.users.list',
		desc: 'List all users in a User Group.'
	},
	'usergroups.users.update' => {
		path: '/usergroups.users.update',
		desc: 'Update the list of users for a user group.'
	},
	'users.conversations' => {
		path: '/users.conversations',
		desc: 'List conversations the calling user may access.'
	},
	'users.deletePhoto' => {
		path: '/users.deletePhoto',
		desc: 'Delete the user profile photo'
	},
	'users.getPresence' => {
		path: '/users.getPresence',
		desc: 'Gets user presence information.'
	},
	'users.identity' => {
		path: '/users.identity',
		desc: 'Get a user\'s identity.'
	},
	'users.info' => {
		path: '/users.info',
		desc: 'Gets information about a user.'
	},
	'users.list' => {
		path: '/users.list',
		desc: 'Lists all users in a Slack team.'
	},
	'users.lookupByEmail' => {
		path: '/users.lookupByEmail',
		desc: 'Find a user with an email address.'
	},
	'users.setActive' => {
		path: '/users.setActive',
		desc: 'Marked a user as active. Deprecated and non-functional.'
	},
	'users.setPhoto' => {
		path: '/users.setPhoto',
		desc: 'Set the user profile photo'
	},
	'users.setPresence' => {
		path: '/users.setPresence',
		desc: 'Manually sets user presence.'
	},
	'users.discoverableContacts.lookup' => {
		path: '/users.discoverableContacts.lookup',
		desc: 'Look up an email address to see if someone is discoverable on Slack'
	},
	'users.profile.get' => {
		path: '/users.profile.get',
		desc: 'Retrieve a user\'s profile information, including their custom status.'
	},
	'users.profile.set' => {
		path: '/users.profile.set',
		desc: 'Set a user\'s profile information, including custom status.'
	},
	'views.open' => {
		path: '/views.open',
		desc: 'Open a view for a user.'
	},
	'views.publish' => {
		path: '/views.publish',
		desc: 'Publish a static view for a User.'
	},
	'views.push' => {
		path: '/views.push',
		desc: 'Push a view onto the stack of a root view.'
	},
	'views.update' => {
		path: '/views.update',
		desc: 'Update an existing view.'
	},
	'workflows.stepCompleted' => {
		path: '/workflows.stepCompleted',
		desc: 'Indicate that an app\'s step in a workflow completed execution.'
	},
	'workflows.stepFailed' => {
		path: '/workflows.stepFailed',
		desc: 'Indicate that an app\'s step in a workflow failed to execute.'
	},
	'workflows.updateStep' => {
		path: '/workflows.updateStep',
		desc: 'Update the configuration for a workflow step.'
	},
	'workflows.triggers.permissions.add' => {
		path: '/workflows.triggers.permissions.add',
		desc: 'Allows users to run a trigger that has its permission type set to named_entities'
	},
	'workflows.triggers.permissions.list' => {
		path: '/workflows.triggers.permissions.list',
		desc: 'Returns the permission type of a trigger and if applicable, includes the entities that have been granted access'
	},
	'workflows.triggers.permissions.remove' => {
		path: '/workflows.triggers.permissions.remove',
		desc: 'Revoke an entity\'s access to a trigger that has its permission type set to named_entities'
	},
	'workflows.triggers.permissions.set' => {
		path: '/workflows.triggers.permissions.set',
		desc: 'Set the permission type for who can run a trigger'
	}
}

Class Method Summary collapse

Class Method Details

.get(key) ⇒ Object



1095
1096
1097
# File 'lib/slackened/methods.rb', line 1095

def get(key)
	METHODS.fetch(key)
end

.path(key) ⇒ Object



1099
1100
1101
# File 'lib/slackened/methods.rb', line 1099

def path(key)
	get(key)[:path]
end