API client for Audit Logs API -See https://api.slack.com/admins/audit-logs for more details
+See https://docs.slack.dev/admins/audit-logs-api/ for more detailstokenslack_sdk.audit_logsAudit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
-Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+Refer to https://docs.slack.dev/tools/python-slack-sdk/audit-logs for details.
API client for Audit Logs API -See https://api.slack.com/admins/audit-logs for more details
+See https://docs.slack.dev/admins/audit-logs-api/ for more detailstokenslack_sdk.audit_logs.v1.async_clientAudit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
-Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+Refer to https://docs.slack.dev/tools/python-slack-sdk/audit-logs for details.
API client for Audit Logs API -See https://api.slack.com/admins/audit-logs for more details
+See https://docs.slack.dev/admins/audit-logs-api/ for more detailstokenslack_sdk.audit_logs.v1.clientAudit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
-Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+Refer to https://docs.slack.dev/tools/python-slack-sdk/audit-logs for details.
API client for Audit Logs API -See https://api.slack.com/admins/audit-logs for more details
+See https://docs.slack.dev/admins/audit-logs-api/ for more detailstokenslack_sdk.audit_logs.v1Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization.
-Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
+Refer to https://docs.slack.dev/tools/python-slack-sdk/audit-logs for details.
slack_sdkHere is the list of key modules in this SDK:
@@ -163,7 +163,7 @@class WebClient(BaseClient):
"""A WebClient allows apps to communicate with the Slack Platform's Web API.
- https://api.slack.com/methods
+ https://docs.slack.dev/reference/methods
The Slack Web API is an interface for querying information from
and enacting change in a Slack workspace.
@@ -234,7 +234,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve analytics data for a given date, presented as a compressed JSON file
- https://api.slack.com/methods/admin.analytics.getFile
+ https://docs.slack.dev/reference/methods/admin.analytics.getFile
"""
kwargs.update({"type": type})
if date is not None:
@@ -256,7 +256,7 @@ Classes
Either app_id or request_id is required.
These IDs can be obtained either directly via the app_requested event,
or by the admin.apps.requests.list method.
- https://api.slack.com/methods/admin.apps.approve
+ https://docs.slack.dev/reference/methods/admin.apps.approve
"""
if app_id:
kwargs.update({"app_id": app_id})
@@ -283,7 +283,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List approved apps for an org or workspace.
- https://api.slack.com/methods/admin.apps.approved.list
+ https://docs.slack.dev/reference/methods/admin.apps.approved.list
"""
kwargs.update(
{
@@ -304,7 +304,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Clear an app resolution
- https://api.slack.com/methods/admin.apps.clearResolution
+ https://docs.slack.dev/reference/methods/admin.apps.clearResolution
"""
kwargs.update(
{
@@ -324,7 +324,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
- https://api.slack.com/methods/admin.apps.requests.cancel
+ https://docs.slack.dev/reference/methods/admin.apps.requests.cancel
"""
kwargs.update(
{
@@ -344,7 +344,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
- https://api.slack.com/methods/admin.apps.requests.list
+ https://docs.slack.dev/reference/methods/admin.apps.requests.list
"""
kwargs.update(
{
@@ -368,7 +368,7 @@ Classes
Exactly one of the team_id or enterprise_id arguments is required, not both.
Either app_id or request_id is required. These IDs can be obtained either directly
via the app_requested event, or by the admin.apps.requests.list method.
- https://api.slack.com/methods/admin.apps.restrict
+ https://docs.slack.dev/reference/methods/admin.apps.restrict
"""
if app_id:
kwargs.update({"app_id": app_id})
@@ -395,7 +395,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List restricted apps for an org or workspace.
- https://api.slack.com/methods/admin.apps.restricted.list
+ https://docs.slack.dev/reference/methods/admin.apps.restricted.list
"""
kwargs.update(
{
@@ -417,7 +417,7 @@ Classes
) -> SlackResponse:
"""Uninstall an app from one or many workspaces, or an entire enterprise organization.
With an org-level token, enterprise_id or team_ids is required.
- https://api.slack.com/methods/admin.apps.uninstall
+ https://docs.slack.dev/reference/methods/admin.apps.uninstall
"""
kwargs.update({"app_id": app_id})
if enterprise_id is not None:
@@ -448,7 +448,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get logs for a specified team/org
- https://api.slack.com/methods/admin.apps.activities.list
+ https://docs.slack.dev/reference/methods/admin.apps.activities.list
"""
kwargs.update(
{
@@ -476,7 +476,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Look up the app config for connectors by their IDs
- https://api.slack.com/methods/admin.apps.config.lookup
+ https://docs.slack.dev/reference/methods/admin.apps.config.lookup
"""
if isinstance(app_ids, (list, tuple)):
kwargs.update({"app_ids": ",".join(app_ids)})
@@ -493,7 +493,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the app config for a connector
- https://api.slack.com/methods/admin.apps.config.set
+ https://docs.slack.dev/reference/methods/admin.apps.config.set
"""
kwargs.update(
{
@@ -515,7 +515,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Fetch all the entities assigned to a particular authentication policy by name.
- https://api.slack.com/methods/admin.auth.policy.getEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities
"""
kwargs.update({"policy_name": policy_name})
if cursor is not None:
@@ -535,7 +535,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Assign entities to a particular authentication policy.
- https://api.slack.com/methods/admin.auth.policy.assignEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.assignEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
@@ -554,7 +554,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove specified entities from a specified authentication policy.
- https://api.slack.com/methods/admin.auth.policy.removeEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.removeEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
@@ -573,7 +573,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create a Salesforce channel for the corresponding object provided.
- https://api.slack.com/methods/admin.conversations.createForObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.createForObjects
"""
kwargs.update(
{"object_id": object_id, "salesforce_org_id": salesforce_org_id, "invite_object_team": invite_object_team}
@@ -589,7 +589,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Link a Salesforce record to a channel.
- https://api.slack.com/methods/admin.conversations.linkObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.linkObjects
"""
kwargs.update(
{
@@ -608,7 +608,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Unlink a Salesforce record from a channel.
- https://api.slack.com/methods/admin.conversations.unlinkObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.unlinkObjects
"""
kwargs.update(
{
@@ -627,7 +627,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create an Information Barrier
- https://api.slack.com/methods/admin.barriers.create
+ https://docs.slack.dev/reference/methods/admin.barriers.create
"""
kwargs.update({"primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
@@ -647,7 +647,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Delete an existing Information Barrier
- https://api.slack.com/methods/admin.barriers.delete
+ https://docs.slack.dev/reference/methods/admin.barriers.delete
"""
kwargs.update({"barrier_id": barrier_id})
return self.api_call("admin.barriers.delete", http_verb="POST", params=kwargs)
@@ -662,7 +662,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update an existing Information Barrier
- https://api.slack.com/methods/admin.barriers.update
+ https://docs.slack.dev/reference/methods/admin.barriers.update
"""
kwargs.update({"barrier_id": barrier_id, "primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
@@ -683,7 +683,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get all Information Barriers for your organization
- https://api.slack.com/methods/admin.barriers.list"""
+ https://docs.slack.dev/reference/methods/admin.barriers.list"""
kwargs.update(
{
"cursor": cursor,
@@ -703,7 +703,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create a public or private channel-based conversation.
- https://api.slack.com/methods/admin.conversations.create
+ https://docs.slack.dev/reference/methods/admin.conversations.create
"""
kwargs.update(
{
@@ -723,7 +723,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Delete a public or private channel.
- https://api.slack.com/methods/admin.conversations.delete
+ https://docs.slack.dev/reference/methods/admin.conversations.delete
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.delete", params=kwargs)
@@ -736,7 +736,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Invite a user to a public or private channel.
- https://api.slack.com/methods/admin.conversations.invite
+ https://docs.slack.dev/reference/methods/admin.conversations.invite
"""
kwargs.update({"channel_id": channel_id})
if isinstance(user_ids, (list, tuple)):
@@ -753,7 +753,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Archive a public or private channel.
- https://api.slack.com/methods/admin.conversations.archive
+ https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.archive", params=kwargs)
@@ -765,7 +765,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Unarchive a public or private channel.
- https://api.slack.com/methods/admin.conversations.archive
+ https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.unarchive", params=kwargs)
@@ -778,7 +778,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Rename a public or private channel.
- https://api.slack.com/methods/admin.conversations.rename
+ https://docs.slack.dev/reference/methods/admin.conversations.rename
"""
kwargs.update({"channel_id": channel_id, "name": name})
return self.api_call("admin.conversations.rename", params=kwargs)
@@ -796,7 +796,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Search for public or private channels in an Enterprise organization.
- https://api.slack.com/methods/admin.conversations.search
+ https://docs.slack.dev/reference/methods/admin.conversations.search
"""
kwargs.update(
{
@@ -827,7 +827,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Convert a public channel to a private channel.
- https://api.slack.com/methods/admin.conversations.convertToPrivate
+ https://docs.slack.dev/reference/methods/admin.conversations.convertToPrivate
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPrivate", params=kwargs)
@@ -839,7 +839,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Convert a privte channel to a public channel.
- https://api.slack.com/methods/admin.conversations.convertToPublic
+ https://docs.slack.dev/reference/methods/admin.conversations.convertToPublic
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPublic", params=kwargs)
@@ -852,7 +852,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the posting permissions for a public or private channel.
- https://api.slack.com/methods/admin.conversations.setConversationPrefs
+ https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
if isinstance(prefs, dict):
@@ -868,7 +868,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get conversation preferences for a public or private channel.
- https://api.slack.com/methods/admin.conversations.getConversationPrefs
+ https://docs.slack.dev/reference/methods/admin.conversations.getConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.getConversationPrefs", params=kwargs)
@@ -881,7 +881,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Disconnect a connected channel from one or more workspaces.
- https://api.slack.com/methods/admin.conversations.disconnectShared
+ https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared
"""
kwargs.update({"channel_id": channel_id})
if isinstance(leaving_team_ids, (list, tuple)):
@@ -901,7 +901,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Returns channels on the given team using the filters.
- https://api.slack.com/methods/admin.conversations.lookup
+ https://docs.slack.dev/reference/methods/admin.conversations.lookup
"""
kwargs.update(
{
@@ -929,7 +929,7 @@ Classes
"""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.
- https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
+ https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
"""
kwargs.update(
{
@@ -956,7 +956,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add an allowlist of IDP groups for accessing a channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup
"""
kwargs.update(
{
@@ -979,7 +979,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all IDP Groups linked to a channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups
"""
kwargs.update(
{
@@ -1002,7 +1002,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove a linked IDP group linked from a private channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.removeGroup
"""
kwargs.update(
{
@@ -1027,7 +1027,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a public or private channel.
- https://api.slack.com/methods/admin.conversations.setTeams
+ https://docs.slack.dev/reference/methods/admin.conversations.setTeams
"""
kwargs.update(
{
@@ -1051,7 +1051,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a channel.
- https://api.slack.com/methods/admin.conversations.getTeams
+ https://docs.slack.dev/reference/methods/admin.conversations.getTeams
"""
kwargs.update(
{
@@ -1069,7 +1069,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get a channel's retention policy
- https://api.slack.com/methods/admin.conversations.getCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.getCustomRetention
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.getCustomRetention", params=kwargs)
@@ -1081,7 +1081,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove a channel's retention policy
- https://api.slack.com/methods/admin.conversations.removeCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.removeCustomRetention
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.removeCustomRetention", params=kwargs)
@@ -1094,7 +1094,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set a channel's retention policy
- https://api.slack.com/methods/admin.conversations.setCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.setCustomRetention
"""
kwargs.update({"channel_id": channel_id, "duration_days": duration_days})
return self.api_call("admin.conversations.setCustomRetention", params=kwargs)
@@ -1106,7 +1106,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Archive public or private channels in bulk.
- https://api.slack.com/methods/admin.conversations.bulkArchive
+ https://docs.slack.dev/reference/methods/admin.conversations.bulkArchive
"""
kwargs.update({"channel_ids": ",".join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call("admin.conversations.bulkArchive", params=kwargs)
@@ -1131,7 +1131,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Move public or private channels in bulk.
- https://api.slack.com/methods/admin.conversations.bulkMove
+ https://docs.slack.dev/reference/methods/admin.conversations.bulkMove
"""
kwargs.update(
{
@@ -1149,7 +1149,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add an emoji.
- https://api.slack.com/methods/admin.emoji.add
+ https://docs.slack.dev/reference/methods/admin.emoji.add
"""
kwargs.update({"name": name, "url": url})
return self.api_call("admin.emoji.add", http_verb="GET", params=kwargs)
@@ -1162,7 +1162,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add an emoji alias.
- https://api.slack.com/methods/admin.emoji.addAlias
+ https://docs.slack.dev/reference/methods/admin.emoji.addAlias
"""
kwargs.update({"alias_for": alias_for, "name": name})
return self.api_call("admin.emoji.addAlias", http_verb="GET", params=kwargs)
@@ -1175,7 +1175,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List emoji for an Enterprise Grid organization.
- https://api.slack.com/methods/admin.emoji.list
+ https://docs.slack.dev/reference/methods/admin.emoji.list
"""
kwargs.update({"cursor": cursor, "limit": limit})
return self.api_call("admin.emoji.list", http_verb="GET", params=kwargs)
@@ -1187,7 +1187,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove an emoji across an Enterprise Grid organization.
- https://api.slack.com/methods/admin.emoji.remove
+ https://docs.slack.dev/reference/methods/admin.emoji.remove
"""
kwargs.update({"name": name})
return self.api_call("admin.emoji.remove", http_verb="GET", params=kwargs)
@@ -1200,7 +1200,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Rename an emoji.
- https://api.slack.com/methods/admin.emoji.rename
+ https://docs.slack.dev/reference/methods/admin.emoji.rename
"""
kwargs.update({"name": name, "new_name": new_name})
return self.api_call("admin.emoji.rename", http_verb="GET", params=kwargs)
@@ -1215,7 +1215,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Look up functions by a set of apps
- https://api.slack.com/methods/admin.functions.list
+ https://docs.slack.dev/reference/methods/admin.functions.list
"""
if isinstance(app_ids, (list, tuple)):
kwargs.update({"app_ids": ",".join(app_ids)})
@@ -1238,7 +1238,7 @@ Classes
) -> SlackResponse:
"""Lookup the visibility of multiple Slack functions
and include the users if it is limited to particular named entities.
- https://api.slack.com/methods/admin.functions.permissions.lookup
+ https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup
"""
if isinstance(function_ids, (list, tuple)):
kwargs.update({"function_ids": ",".join(function_ids)})
@@ -1256,7 +1256,7 @@ Classes
) -> SlackResponse:
"""Set the visibility of a Slack function
and define the users or workspaces if it is set to named_entities
- https://api.slack.com/methods/admin.functions.permissions.set
+ https://docs.slack.dev/reference/methods/admin.functions.permissions.set
"""
kwargs.update(
{
@@ -1280,7 +1280,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Adds members to the specified role with the specified scopes
- https://api.slack.com/methods/admin.roles.addAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.addAssignments
"""
kwargs.update({"role_id": role_id})
if isinstance(entity_ids, (list, tuple)):
@@ -1305,7 +1305,7 @@ Classes
) -> SlackResponse:
"""Lists assignments for all roles across entities.
Options to scope results by any combination of roles or entities
- https://api.slack.com/methods/admin.roles.listAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.listAssignments
"""
kwargs.update({"cursor": cursor, "limit": limit, "sort_dir": sort_dir})
if isinstance(entity_ids, (list, tuple)):
@@ -1327,7 +1327,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Removes a set of users from a role for the given scopes and entities
- https://api.slack.com/methods/admin.roles.removeAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.removeAssignments
"""
kwargs.update({"role_id": role_id})
if isinstance(entity_ids, (list, tuple)):
@@ -1349,7 +1349,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Wipes all valid sessions on all devices for a given user.
- https://api.slack.com/methods/admin.users.session.reset
+ https://docs.slack.dev/reference/methods/admin.users.session.reset
"""
kwargs.update(
{
@@ -1369,7 +1369,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
- https://api.slack.com/methods/admin.users.session.resetBulk
+ https://docs.slack.dev/reference/methods/admin.users.session.resetBulk
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -1391,7 +1391,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Invalidate a single session for a user by session_id.
- https://api.slack.com/methods/admin.users.session.invalidate
+ https://docs.slack.dev/reference/methods/admin.users.session.invalidate
"""
kwargs.update({"session_id": session_id, "team_id": team_id})
return self.api_call("admin.users.session.invalidate", params=kwargs)
@@ -1406,7 +1406,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists all active user sessions for an organization
- https://api.slack.com/methods/admin.users.session.list
+ https://docs.slack.dev/reference/methods/admin.users.session.list
"""
kwargs.update(
{
@@ -1426,7 +1426,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the default channels of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setDefaultChannels
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDefaultChannels
"""
kwargs.update({"team_id": team_id})
if isinstance(channel_ids, (list, tuple)):
@@ -1443,7 +1443,7 @@ Classes
) -> SlackResponse:
"""Get user-specific session settings—the session duration
and what happens when the client closes—given a list of users.
- https://api.slack.com/methods/admin.users.session.getSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.getSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -1461,7 +1461,7 @@ Classes
) -> SlackResponse:
"""Configure the user-level session settings—the session duration
and what happens when the client closes—for one or more users.
- https://api.slack.com/methods/admin.users.session.setSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.setSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -1483,7 +1483,7 @@ Classes
) -> SlackResponse:
"""Clear user-specific session settings—the session duration
and what happens when the client closes—for a list of users.
- https://api.slack.com/methods/admin.users.session.clearSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.clearSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -1500,7 +1500,7 @@ Classes
) -> SlackResponse:
"""Ask Slackbot to send you an export listing all workspace members using unsupported software,
presented as a zipped CSV file.
- https://api.slack.com/methods/admin.users.unsupportedVersions.export
+ https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export
"""
kwargs.update(
{
@@ -1518,7 +1518,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Approve a workspace invite request.
- https://api.slack.com/methods/admin.inviteRequests.approve
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.approve
"""
kwargs.update({"invite_request_id": invite_request_id, "team_id": team_id})
return self.api_call("admin.inviteRequests.approve", params=kwargs)
@@ -1532,7 +1532,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all approved workspace invite requests.
- https://api.slack.com/methods/admin.inviteRequests.approved.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.approved.list
"""
kwargs.update(
{
@@ -1552,7 +1552,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all denied workspace invite requests.
- https://api.slack.com/methods/admin.inviteRequests.denied.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.denied.list
"""
kwargs.update(
{
@@ -1571,7 +1571,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deny a workspace invite request.
- https://api.slack.com/methods/admin.inviteRequests.deny
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.deny
"""
kwargs.update({"invite_request_id": invite_request_id, "team_id": team_id})
return self.api_call("admin.inviteRequests.deny", params=kwargs)
@@ -1592,7 +1592,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
- https://api.slack.com/methods/admin.inviteRequests.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.list
"""
kwargs.update(
{
@@ -1613,7 +1613,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create an Enterprise team.
- https://api.slack.com/methods/admin.teams.create
+ https://docs.slack.dev/reference/methods/admin.teams.create
"""
kwargs.update(
{
@@ -1633,7 +1633,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all teams on an Enterprise organization.
- https://api.slack.com/methods/admin.teams.list
+ https://docs.slack.dev/reference/methods/admin.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit})
return self.api_call("admin.teams.list", params=kwargs)
@@ -1647,7 +1647,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
- https://api.slack.com/methods/admin.teams.owners.list
+ https://docs.slack.dev/reference/methods/admin.teams.owners.list
"""
kwargs.update({"team_id": team_id, "cursor": cursor, "limit": limit})
return self.api_call("admin.teams.owners.list", http_verb="GET", params=kwargs)
@@ -1659,7 +1659,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Fetch information about settings in a workspace
- https://api.slack.com/methods/admin.teams.settings.info
+ https://docs.slack.dev/reference/methods/admin.teams.settings.info
"""
kwargs.update({"team_id": team_id})
return self.api_call("admin.teams.settings.info", params=kwargs)
@@ -1672,7 +1672,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the description of a given workspace.
- https://api.slack.com/methods/admin.teams.settings.setDescription
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDescription
"""
kwargs.update({"team_id": team_id, "description": description})
return self.api_call("admin.teams.settings.setDescription", params=kwargs)
@@ -1685,7 +1685,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setDiscoverability
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDiscoverability
"""
kwargs.update({"team_id": team_id, "discoverability": discoverability})
return self.api_call("admin.teams.settings.setDiscoverability", params=kwargs)
@@ -1698,7 +1698,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setIcon
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setIcon
"""
kwargs.update({"team_id": team_id, "image_url": image_url})
return self.api_call("admin.teams.settings.setIcon", http_verb="GET", params=kwargs)
@@ -1711,7 +1711,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setName
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setName
"""
kwargs.update({"team_id": team_id, "name": name})
return self.api_call("admin.teams.settings.setName", params=kwargs)
@@ -1725,7 +1725,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.addChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.addChannels
"""
kwargs.update({"team_id": team_id, "usergroup_id": usergroup_id})
if isinstance(channel_ids, (list, tuple)):
@@ -1743,7 +1743,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Associate one or more default workspaces with an organization-wide IDP group.
- https://api.slack.com/methods/admin.usergroups.addTeams
+ https://docs.slack.dev/reference/methods/admin.usergroups.addTeams
"""
kwargs.update({"usergroup_id": usergroup_id, "auto_provision": auto_provision})
if isinstance(team_ids, (list, tuple)):
@@ -1761,7 +1761,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.listChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.listChannels
"""
kwargs.update(
{
@@ -1780,7 +1780,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.removeChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels
"""
kwargs.update({"usergroup_id": usergroup_id})
if isinstance(channel_ids, (list, tuple)):
@@ -1800,7 +1800,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add an Enterprise user to a workspace.
- https://api.slack.com/methods/admin.users.assign
+ https://docs.slack.dev/reference/methods/admin.users.assign
"""
kwargs.update(
{
@@ -1832,7 +1832,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Invite a user to a workspace.
- https://api.slack.com/methods/admin.users.invite
+ https://docs.slack.dev/reference/methods/admin.users.invite
"""
kwargs.update(
{
@@ -1856,7 +1856,7 @@ Classes
def admin_users_list(
self,
*,
- team_id: str,
+ team_id: Optional[str] = None,
include_deactivated_user_workspaces: Optional[bool] = None,
is_active: Optional[bool] = None,
cursor: Optional[str] = None,
@@ -1864,7 +1864,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List users on a workspace
- https://api.slack.com/methods/admin.users.list
+ https://docs.slack.dev/reference/methods/admin.users.list
"""
kwargs.update(
{
@@ -1885,7 +1885,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove a user from a workspace.
- https://api.slack.com/methods/admin.users.remove
+ https://docs.slack.dev/reference/methods/admin.users.remove
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.remove", params=kwargs)
@@ -1898,7 +1898,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or owner to be an admin user.
- https://api.slack.com/methods/admin.users.setAdmin
+ https://docs.slack.dev/reference/methods/admin.users.setAdmin
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setAdmin", params=kwargs)
@@ -1912,7 +1912,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set an expiration for a guest user.
- https://api.slack.com/methods/admin.users.setExpiration
+ https://docs.slack.dev/reference/methods/admin.users.setExpiration
"""
kwargs.update({"expiration_ts": expiration_ts, "team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setExpiration", params=kwargs)
@@ -1925,7 +1925,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or admin user to be a workspace owner.
- https://api.slack.com/methods/admin.users.setOwner
+ https://docs.slack.dev/reference/methods/admin.users.setOwner
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setOwner", params=kwargs)
@@ -1938,7 +1938,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest user, admin user, or owner to be a regular user.
- https://api.slack.com/methods/admin.users.setRegular
+ https://docs.slack.dev/reference/methods/admin.users.setRegular
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setRegular", params=kwargs)
@@ -1959,7 +1959,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Search workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.search
+ https://docs.slack.dev/reference/methods/admin.workflows.search
"""
if collaborator_ids is not None:
if isinstance(collaborator_ids, (list, tuple)):
@@ -1989,7 +1989,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Look up the permissions for a set of workflows
- https://api.slack.com/methods/admin.workflows.permissions.lookup
+ https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup
"""
if isinstance(workflow_ids, (list, tuple)):
kwargs.update({"workflow_ids": ",".join(workflow_ids)})
@@ -2010,7 +2010,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add collaborators to workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.collaborators.add
+ https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add
"""
if isinstance(collaborator_ids, (list, tuple)):
kwargs.update({"collaborator_ids": ",".join(collaborator_ids)})
@@ -2030,7 +2030,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove collaborators from workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.collaborators.remove
+ https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove
"""
if isinstance(collaborator_ids, (list, tuple)):
kwargs.update({"collaborator_ids": ",".join(collaborator_ids)})
@@ -2049,7 +2049,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Unpublish workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.unpublish
+ https://docs.slack.dev/reference/methods/admin.workflows.unpublish
"""
if isinstance(workflow_ids, (list, tuple)):
kwargs.update({"workflow_ids": ",".join(workflow_ids)})
@@ -2064,7 +2064,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Checks API calling code.
- https://api.slack.com/methods/api.test
+ https://docs.slack.dev/reference/methods/api.test
"""
kwargs.update({"error": error})
return self.api_call("api.test", params=kwargs)
@@ -2077,7 +2077,7 @@ Classes
) -> SlackResponse:
"""Generate a temporary Socket Mode WebSocket URL that your app can connect to
in order to receive events and interactive payloads
- https://api.slack.com/methods/apps.connections.open
+ https://docs.slack.dev/reference/methods/apps.connections.open
"""
kwargs.update({"token": app_token})
return self.api_call("apps.connections.open", http_verb="POST", params=kwargs)
@@ -2092,7 +2092,7 @@ Classes
) -> SlackResponse:
"""Get a list of authorizations for the given event context.
Each authorization represents an app installation that the event is visible to.
- https://api.slack.com/methods/apps.event.authorizations.list
+ https://docs.slack.dev/reference/methods/apps.event.authorizations.list
"""
kwargs.update({"event_context": event_context, "cursor": cursor, "limit": limit})
return self.api_call("apps.event.authorizations.list", params=kwargs)
@@ -2105,7 +2105,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Uninstalls your app from a workspace.
- https://api.slack.com/methods/apps.uninstall
+ https://docs.slack.dev/reference/methods/apps.uninstall
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret})
return self.api_call("apps.uninstall", params=kwargs)
@@ -2117,7 +2117,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create an app from an app manifest
- https://api.slack.com/methods/apps.manifest.create
+ https://docs.slack.dev/reference/methods/apps.manifest.create
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -2132,7 +2132,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Permanently deletes an app created through app manifests
- https://api.slack.com/methods/apps.manifest.delete
+ https://docs.slack.dev/reference/methods/apps.manifest.delete
"""
kwargs.update({"app_id": app_id})
return self.api_call("apps.manifest.delete", params=kwargs)
@@ -2144,7 +2144,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Export an app manifest from an existing app
- https://api.slack.com/methods/apps.manifest.export
+ https://docs.slack.dev/reference/methods/apps.manifest.export
"""
kwargs.update({"app_id": app_id})
return self.api_call("apps.manifest.export", params=kwargs)
@@ -2157,7 +2157,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update an app from an app manifest
- https://api.slack.com/methods/apps.manifest.update
+ https://docs.slack.dev/reference/methods/apps.manifest.update
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -2174,7 +2174,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Validate an app manifest
- https://api.slack.com/methods/apps.manifest.validate
+ https://docs.slack.dev/reference/methods/apps.manifest.validate
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -2190,7 +2190,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a refresh token for a new app configuration token
- https://api.slack.com/methods/tooling.tokens.rotate
+ https://docs.slack.dev/reference/methods/tooling.tokens.rotate
"""
kwargs.update({"refresh_token": refresh_token})
return self.api_call("tooling.tokens.rotate", params=kwargs)
@@ -2204,7 +2204,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setStatus
+ https://docs.slack.dev/reference/methods/assistant.threads.setStatus
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "status": status})
return self.api_call("assistant.threads.setStatus", params=kwargs)
@@ -2218,7 +2218,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setTitle
+ https://docs.slack.dev/reference/methods/assistant.threads.setTitle
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "title": title})
return self.api_call("assistant.threads.setTitle", params=kwargs)
@@ -2233,7 +2233,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setSuggestedPrompts
+ https://docs.slack.dev/reference/methods/assistant.threads.setSuggestedPrompts
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "prompts": prompts})
if title is not None:
@@ -2247,7 +2247,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/auth.revoke
+ https://docs.slack.dev/reference/methods/auth.revoke
"""
kwargs.update({"test": test})
return self.api_call("auth.revoke", http_verb="GET", params=kwargs)
@@ -2257,7 +2257,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Checks authentication & identity.
- https://api.slack.com/methods/auth.test
+ https://docs.slack.dev/reference/methods/auth.test
"""
return self.api_call("auth.test", params=kwargs)
@@ -2269,7 +2269,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List the workspaces a token can access.
- https://api.slack.com/methods/auth.teams.list
+ https://docs.slack.dev/reference/methods/auth.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit, "include_icon": include_icon})
return self.api_call("auth.teams.list", params=kwargs)
@@ -2287,7 +2287,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Add bookmark to a channel.
- https://api.slack.com/methods/bookmarks.add
+ https://docs.slack.dev/reference/methods/bookmarks.add
"""
kwargs.update(
{
@@ -2313,7 +2313,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Edit bookmark.
- https://api.slack.com/methods/bookmarks.edit
+ https://docs.slack.dev/reference/methods/bookmarks.edit
"""
kwargs.update(
{
@@ -2333,7 +2333,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List bookmark for the channel.
- https://api.slack.com/methods/bookmarks.list
+ https://docs.slack.dev/reference/methods/bookmarks.list
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("bookmarks.list", http_verb="POST", params=kwargs)
@@ -2346,7 +2346,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove bookmark from the channel.
- https://api.slack.com/methods/bookmarks.remove
+ https://docs.slack.dev/reference/methods/bookmarks.remove
"""
kwargs.update({"bookmark_id": bookmark_id, "channel_id": channel_id})
return self.api_call("bookmarks.remove", http_verb="POST", params=kwargs)
@@ -2359,7 +2359,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets information about a bot user.
- https://api.slack.com/methods/bots.info
+ https://docs.slack.dev/reference/methods/bots.info
"""
kwargs.update({"bot": bot, "team_id": team_id})
return self.api_call("bots.info", http_verb="GET", params=kwargs)
@@ -2378,7 +2378,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Registers a new Call.
- https://api.slack.com/methods/calls.add
+ https://docs.slack.dev/reference/methods/calls.add
"""
kwargs.update(
{
@@ -2405,7 +2405,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Ends a Call.
- https://api.slack.com/methods/calls.end
+ https://docs.slack.dev/reference/methods/calls.end
"""
kwargs.update({"id": id, "duration": duration})
return self.api_call("calls.end", http_verb="POST", params=kwargs)
@@ -2417,7 +2417,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Returns information about a Call.
- https://api.slack.com/methods/calls.info
+ https://docs.slack.dev/reference/methods/calls.info
"""
kwargs.update({"id": id})
return self.api_call("calls.info", http_verb="POST", params=kwargs)
@@ -2430,7 +2430,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Registers new participants added to a Call.
- https://api.slack.com/methods/calls.participants.add
+ https://docs.slack.dev/reference/methods/calls.participants.add
"""
kwargs.update({"id": id})
_update_call_participants(kwargs, users)
@@ -2444,7 +2444,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Registers participants removed from a Call.
- https://api.slack.com/methods/calls.participants.remove
+ https://docs.slack.dev/reference/methods/calls.participants.remove
"""
kwargs.update({"id": id})
_update_call_participants(kwargs, users)
@@ -2460,7 +2460,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Updates information about a Call.
- https://api.slack.com/methods/calls.update
+ https://docs.slack.dev/reference/methods/calls.update
"""
kwargs.update(
{
@@ -2480,7 +2480,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create Canvas for a user
- https://api.slack.com/methods/canvases.create
+ https://docs.slack.dev/reference/methods/canvases.create
"""
kwargs.update({"title": title, "document_content": document_content})
return self.api_call("canvases.create", json=kwargs)
@@ -2493,7 +2493,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update an existing canvas
- https://api.slack.com/methods/canvases.edit
+ https://docs.slack.dev/reference/methods/canvases.edit
"""
kwargs.update({"canvas_id": canvas_id, "changes": changes})
return self.api_call("canvases.edit", json=kwargs)
@@ -2505,7 +2505,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes a canvas
- https://api.slack.com/methods/canvases.delete
+ https://docs.slack.dev/reference/methods/canvases.delete
"""
kwargs.update({"canvas_id": canvas_id})
return self.api_call("canvases.delete", params=kwargs)
@@ -2520,7 +2520,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the access level to a canvas for specified entities
- https://api.slack.com/methods/canvases.access.set
+ https://docs.slack.dev/reference/methods/canvases.access.set
"""
kwargs.update({"canvas_id": canvas_id, "access_level": access_level})
if channel_ids is not None:
@@ -2545,7 +2545,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create a Channel Canvas for a channel
- https://api.slack.com/methods/canvases.access.delete
+ https://docs.slack.dev/reference/methods/canvases.access.delete
"""
kwargs.update({"canvas_id": canvas_id})
if channel_ids is not None:
@@ -2568,7 +2568,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Find sections matching the provided criteria
- https://api.slack.com/methods/canvases.sections.lookup
+ https://docs.slack.dev/reference/methods/canvases.sections.lookup
"""
kwargs.update({"canvas_id": canvas_id, "criteria": json.dumps(criteria)})
return self.api_call("canvases.sections.lookup", params=kwargs)
@@ -2576,7 +2576,7 @@ Classes
# --------------------------
# Deprecated: channels.*
# You can use conversations.* APIs instead.
- # https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api
+ # https://docs.slack.dev/changelog/2020-01-deprecating-antecedents-to-the-conversations-api/
# --------------------------
def channels_archive(
@@ -2755,7 +2755,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes a message.
- https://api.slack.com/methods/chat.delete
+ https://docs.slack.dev/reference/methods/chat.delete
"""
kwargs.update({"channel": channel, "ts": ts, "as_user": as_user})
return self.api_call("chat.delete", params=kwargs)
@@ -2769,7 +2769,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes a scheduled message.
- https://api.slack.com/methods/chat.deleteScheduledMessage
+ https://docs.slack.dev/reference/methods/chat.deleteScheduledMessage
"""
kwargs.update(
{
@@ -2788,7 +2788,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve a permalink URL for a specific extant message
- https://api.slack.com/methods/chat.getPermalink
+ https://docs.slack.dev/reference/methods/chat.getPermalink
"""
kwargs.update({"channel": channel, "message_ts": message_ts})
return self.api_call("chat.getPermalink", http_verb="GET", params=kwargs)
@@ -2801,7 +2801,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Share a me message into a channel.
- https://api.slack.com/methods/chat.meMessage
+ https://docs.slack.dev/reference/methods/chat.meMessage
"""
kwargs.update({"channel": channel, "text": text})
return self.api_call("chat.meMessage", params=kwargs)
@@ -2821,10 +2821,11 @@ Classes
link_names: Optional[bool] = None,
username: Optional[str] = None,
parse: Optional[str] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Sends an ephemeral message to a user in a channel.
- https://api.slack.com/methods/chat.postEphemeral
+ https://docs.slack.dev/reference/methods/chat.postEphemeral
"""
kwargs.update(
{
@@ -2840,11 +2841,12 @@ Classes
"link_names": link_names,
"username": username,
"parse": parse,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.postEphemeral", kwargs)
+ _warn_if_message_text_content_is_missing("chat.postEphemeral", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.postEphemeral", json=kwargs)
@@ -2868,10 +2870,11 @@ Classes
username: Optional[str] = None,
parse: Optional[str] = None, # none, full
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Sends a message to a channel.
- https://api.slack.com/methods/chat.postMessage
+ https://docs.slack.dev/reference/methods/chat.postMessage
"""
kwargs.update(
{
@@ -2892,11 +2895,12 @@ Classes
"username": username,
"parse": parse,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.postMessage", kwargs)
+ _warn_if_message_text_content_is_missing("chat.postMessage", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.postMessage", json=kwargs)
@@ -2905,7 +2909,7 @@ Classes
*,
channel: str,
post_at: Union[str, int],
- text: str,
+ text: Optional[str] = None,
as_user: Optional[bool] = None,
attachments: Optional[Union[str, Sequence[Union[Dict, Attachment]]]] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
@@ -2916,10 +2920,11 @@ Classes
unfurl_media: Optional[bool] = None,
link_names: Optional[bool] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Schedules a message.
- https://api.slack.com/methods/chat.scheduleMessage
+ https://docs.slack.dev/reference/methods/chat.scheduleMessage
"""
kwargs.update(
{
@@ -2936,11 +2941,12 @@ Classes
"unfurl_media": unfurl_media,
"link_names": link_names,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.scheduleMessage", kwargs)
+ _warn_if_message_text_content_is_missing("chat.scheduleMessage", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.scheduleMessage", json=kwargs)
@@ -2959,7 +2965,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Provide custom unfurl behavior for user-posted URLs.
- https://api.slack.com/methods/chat.unfurl
+ https://docs.slack.dev/reference/methods/chat.unfurl
"""
kwargs.update(
{
@@ -2993,10 +2999,11 @@ Classes
parse: Optional[str] = None, # none, full
reply_broadcast: Optional[bool] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Updates a message in a channel.
- https://api.slack.com/methods/chat.update
+ https://docs.slack.dev/reference/methods/chat.update
"""
kwargs.update(
{
@@ -3010,6 +3017,7 @@ Classes
"parse": parse,
"reply_broadcast": reply_broadcast,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
if isinstance(file_ids, (list, tuple)):
@@ -3018,7 +3026,7 @@ Classes
kwargs.update({"file_ids": file_ids})
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.update", kwargs)
+ _warn_if_message_text_content_is_missing("chat.update", kwargs)
# NOTE: intentionally using json over params for API methods using blocks/attachments
return self.api_call("chat.update", json=kwargs)
@@ -3034,7 +3042,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists all scheduled messages.
- https://api.slack.com/methods/chat.scheduledMessages.list
+ https://docs.slack.dev/reference/methods/chat.scheduledMessages.list
"""
kwargs.update(
{
@@ -3060,7 +3068,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Accepts an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.acceptSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite
"""
if channel_id is None and invite_id is None:
raise e.SlackRequestError("Either channel_id or invite_id must be provided.")
@@ -3084,7 +3092,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Approves an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.approveSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.approveSharedInvite
"""
kwargs.update({"invite_id": invite_id, "target_team": target_team})
return self.api_call("conversations.approveSharedInvite", http_verb="POST", params=kwargs)
@@ -3096,7 +3104,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Archives a conversation.
- https://api.slack.com/methods/conversations.archive
+ https://docs.slack.dev/reference/methods/conversations.archive
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.archive", params=kwargs)
@@ -3108,7 +3116,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Closes a direct message or multi-person direct message.
- https://api.slack.com/methods/conversations.close
+ https://docs.slack.dev/reference/methods/conversations.close
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.close", params=kwargs)
@@ -3122,7 +3130,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Initiates a public or private channel-based conversation
- https://api.slack.com/methods/conversations.create
+ https://docs.slack.dev/reference/methods/conversations.create
"""
kwargs.update({"name": name, "is_private": is_private, "team_id": team_id})
return self.api_call("conversations.create", params=kwargs)
@@ -3135,7 +3143,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Declines a Slack Connect channel invite.
- https://api.slack.com/methods/conversations.declineSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.declineSharedInvite
"""
kwargs.update({"invite_id": invite_id, "target_team": target_team})
return self.api_call("conversations.declineSharedInvite", http_verb="GET", params=kwargs)
@@ -3144,7 +3152,7 @@ Classes
self, *, action: str, channel: str, target_team: str, **kwargs
) -> SlackResponse:
"""Sets a team in a shared External Limited channel to a shared Slack Connect channel or vice versa.
- https://api.slack.com/methods/conversations.externalInvitePermissions.set
+ https://docs.slack.dev/reference/methods/conversations.externalInvitePermissions.set
"""
kwargs.update(
{
@@ -3168,7 +3176,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Fetches a conversation's history of messages and events.
- https://api.slack.com/methods/conversations.history
+ https://docs.slack.dev/reference/methods/conversations.history
"""
kwargs.update(
{
@@ -3192,7 +3200,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve information about a conversation.
- https://api.slack.com/methods/conversations.info
+ https://docs.slack.dev/reference/methods/conversations.info
"""
kwargs.update(
{
@@ -3212,7 +3220,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Invites users to a channel.
- https://api.slack.com/methods/conversations.invite
+ https://docs.slack.dev/reference/methods/conversations.invite
"""
kwargs.update(
{
@@ -3235,7 +3243,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sends an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.inviteShared
+ https://docs.slack.dev/reference/methods/conversations.inviteShared
"""
if emails is None and user_ids is None:
raise e.SlackRequestError("Either emails or user ids must be provided.")
@@ -3257,7 +3265,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Joins an existing conversation.
- https://api.slack.com/methods/conversations.join
+ https://docs.slack.dev/reference/methods/conversations.join
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.join", params=kwargs)
@@ -3270,7 +3278,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Removes a user from a conversation.
- https://api.slack.com/methods/conversations.kick
+ https://docs.slack.dev/reference/methods/conversations.kick
"""
kwargs.update({"channel": channel, "user": user})
return self.api_call("conversations.kick", params=kwargs)
@@ -3282,7 +3290,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Leaves a conversation.
- https://api.slack.com/methods/conversations.leave
+ https://docs.slack.dev/reference/methods/conversations.leave
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.leave", params=kwargs)
@@ -3298,7 +3306,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists all channels in a Slack team.
- https://api.slack.com/methods/conversations.list
+ https://docs.slack.dev/reference/methods/conversations.list
"""
kwargs.update(
{
@@ -3324,7 +3332,7 @@ Classes
) -> SlackResponse:
"""List shared channel invites that have been generated
or received but have not yet been approved by all parties.
- https://api.slack.com/methods/conversations.listConnectInvites
+ https://docs.slack.dev/reference/methods/conversations.listConnectInvites
"""
kwargs.update({"count": count, "cursor": cursor, "team_id": team_id})
return self.api_call("conversations.listConnectInvites", params=kwargs)
@@ -3337,7 +3345,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the read cursor in a channel.
- https://api.slack.com/methods/conversations.mark
+ https://docs.slack.dev/reference/methods/conversations.mark
"""
kwargs.update({"channel": channel, "ts": ts})
return self.api_call("conversations.mark", params=kwargs)
@@ -3351,7 +3359,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve members of a conversation.
- https://api.slack.com/methods/conversations.members
+ https://docs.slack.dev/reference/methods/conversations.members
"""
kwargs.update({"channel": channel, "cursor": cursor, "limit": limit})
return self.api_call("conversations.members", http_verb="GET", params=kwargs)
@@ -3365,7 +3373,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Opens or resumes a direct message or multi-person direct message.
- https://api.slack.com/methods/conversations.open
+ https://docs.slack.dev/reference/methods/conversations.open
"""
if channel is None and users is None:
raise e.SlackRequestError("Either channel or users must be provided.")
@@ -3384,7 +3392,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Renames a conversation.
- https://api.slack.com/methods/conversations.rename
+ https://docs.slack.dev/reference/methods/conversations.rename
"""
kwargs.update({"channel": channel, "name": name})
return self.api_call("conversations.rename", params=kwargs)
@@ -3403,7 +3411,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve a thread of messages posted to a conversation
- https://api.slack.com/methods/conversations.replies
+ https://docs.slack.dev/reference/methods/conversations.replies
"""
kwargs.update(
{
@@ -3429,7 +3437,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Approve a request to add an external user to a channel. This also sends them a Slack Connect invite.
- https://api.slack.com/methods/conversations.requestSharedInvite.approve
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.approve
"""
kwargs.update(
{
@@ -3450,7 +3458,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deny a request to invite an external user to a channel.
- https://api.slack.com/methods/conversations.requestSharedInvite.deny
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.deny
"""
kwargs.update({"invite_id": invite_id, "message": message})
return self.api_call("conversations.requestSharedInvite.deny", params=kwargs)
@@ -3468,7 +3476,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists requests to add external users to channels with ability to filter.
- https://api.slack.com/methods/conversations.requestSharedInvite.list
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.list
"""
kwargs.update(
{
@@ -3495,7 +3503,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the purpose for a conversation.
- https://api.slack.com/methods/conversations.setPurpose
+ https://docs.slack.dev/reference/methods/conversations.setPurpose
"""
kwargs.update({"channel": channel, "purpose": purpose})
return self.api_call("conversations.setPurpose", params=kwargs)
@@ -3508,7 +3516,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Sets the topic for a conversation.
- https://api.slack.com/methods/conversations.setTopic
+ https://docs.slack.dev/reference/methods/conversations.setTopic
"""
kwargs.update({"channel": channel, "topic": topic})
return self.api_call("conversations.setTopic", params=kwargs)
@@ -3520,7 +3528,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Reverses conversation archival.
- https://api.slack.com/methods/conversations.unarchive
+ https://docs.slack.dev/reference/methods/conversations.unarchive
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.unarchive", params=kwargs)
@@ -3533,7 +3541,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create a Channel Canvas for a channel
- https://api.slack.com/methods/conversations.canvases.create
+ https://docs.slack.dev/reference/methods/conversations.canvases.create
"""
kwargs.update({"channel_id": channel_id, "document_content": document_content})
return self.api_call("conversations.canvases.create", json=kwargs)
@@ -3546,7 +3554,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Open a dialog with a user.
- https://api.slack.com/methods/dialog.open
+ https://docs.slack.dev/reference/methods/dialog.open
"""
kwargs.update({"dialog": dialog, "trigger_id": trigger_id})
kwargs = _remove_none_values(kwargs)
@@ -3558,7 +3566,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Ends the current user's Do Not Disturb session immediately.
- https://api.slack.com/methods/dnd.endDnd
+ https://docs.slack.dev/reference/methods/dnd.endDnd
"""
return self.api_call("dnd.endDnd", params=kwargs)
@@ -3567,7 +3575,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Ends the current user's snooze mode immediately.
- https://api.slack.com/methods/dnd.endSnooze
+ https://docs.slack.dev/reference/methods/dnd.endSnooze
"""
return self.api_call("dnd.endSnooze", params=kwargs)
@@ -3579,7 +3587,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieves a user's current Do Not Disturb status.
- https://api.slack.com/methods/dnd.info
+ https://docs.slack.dev/reference/methods/dnd.info
"""
kwargs.update({"team_id": team_id, "user": user})
return self.api_call("dnd.info", http_verb="GET", params=kwargs)
@@ -3591,7 +3599,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Turns on Do Not Disturb mode for the current user, or changes its duration.
- https://api.slack.com/methods/dnd.setSnooze
+ https://docs.slack.dev/reference/methods/dnd.setSnooze
"""
kwargs.update({"num_minutes": num_minutes})
return self.api_call("dnd.setSnooze", http_verb="GET", params=kwargs)
@@ -3603,7 +3611,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieves the Do Not Disturb status for users on a team.
- https://api.slack.com/methods/dnd.teamInfo
+ https://docs.slack.dev/reference/methods/dnd.teamInfo
"""
if isinstance(users, (list, tuple)):
kwargs.update({"users": ",".join(users)})
@@ -3618,7 +3626,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists custom emoji for a team.
- https://api.slack.com/methods/emoji.list
+ https://docs.slack.dev/reference/methods/emoji.list
"""
kwargs.update({"include_categories": include_categories})
return self.api_call("emoji.list", http_verb="GET", params=kwargs)
@@ -3631,7 +3639,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes an existing comment on a file.
- https://api.slack.com/methods/files.comments.delete
+ https://docs.slack.dev/reference/methods/files.comments.delete
"""
kwargs.update({"file": file, "id": id})
return self.api_call("files.comments.delete", params=kwargs)
@@ -3643,7 +3651,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes a file.
- https://api.slack.com/methods/files.delete
+ https://docs.slack.dev/reference/methods/files.delete
"""
kwargs.update({"file": file})
return self.api_call("files.delete", params=kwargs)
@@ -3659,7 +3667,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets information about a team file.
- https://api.slack.com/methods/files.info
+ https://docs.slack.dev/reference/methods/files.info
"""
kwargs.update(
{
@@ -3687,7 +3695,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists & filters team files.
- https://api.slack.com/methods/files.list
+ https://docs.slack.dev/reference/methods/files.list
"""
kwargs.update(
{
@@ -3715,7 +3723,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve information about a remote file added to Slack.
- https://api.slack.com/methods/files.remote.info
+ https://docs.slack.dev/reference/methods/files.remote.info
"""
kwargs.update({"external_id": external_id, "file": file})
return self.api_call("files.remote.info", http_verb="GET", params=kwargs)
@@ -3731,7 +3739,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve information about a remote file added to Slack.
- https://api.slack.com/methods/files.remote.list
+ https://docs.slack.dev/reference/methods/files.remote.list
"""
kwargs.update(
{
@@ -3756,7 +3764,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Adds a file from a remote service.
- https://api.slack.com/methods/files.remote.add
+ https://docs.slack.dev/reference/methods/files.remote.add
"""
kwargs.update(
{
@@ -3795,7 +3803,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Updates an existing remote file.
- https://api.slack.com/methods/files.remote.update
+ https://docs.slack.dev/reference/methods/files.remote.update
"""
kwargs.update(
{
@@ -3830,7 +3838,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Remove a remote file.
- https://api.slack.com/methods/files.remote.remove
+ https://docs.slack.dev/reference/methods/files.remote.remove
"""
kwargs.update({"external_id": external_id, "file": file})
return self.api_call("files.remote.remove", http_verb="POST", params=kwargs)
@@ -3844,7 +3852,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Share a remote file into a channel.
- https://api.slack.com/methods/files.remote.share
+ https://docs.slack.dev/reference/methods/files.remote.share
"""
if external_id is None and file is None:
raise e.SlackRequestError("Either external_id or file must be provided.")
@@ -3862,7 +3870,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Revokes public/external sharing access for a file
- https://api.slack.com/methods/files.revokePublicURL
+ https://docs.slack.dev/reference/methods/files.revokePublicURL
"""
kwargs.update({"file": file})
return self.api_call("files.revokePublicURL", params=kwargs)
@@ -3874,7 +3882,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Enables a file for public/external sharing.
- https://api.slack.com/methods/files.sharedPublicURL
+ https://docs.slack.dev/reference/methods/files.sharedPublicURL
"""
kwargs.update({"file": file})
return self.api_call("files.sharedPublicURL", params=kwargs)
@@ -3893,7 +3901,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Uploads or creates a file.
- https://api.slack.com/methods/files.upload
+ https://docs.slack.dev/reference/methods/files.upload
"""
_print_files_upload_v2_suggestion()
@@ -3946,12 +3954,12 @@ Classes
) -> SlackResponse:
"""This wrapper method provides an easy way to upload files using the following endpoints:
- - step1: https://api.slack.com/methods/files.getUploadURLExternal
+ - step1: https://docs.slack.dev/reference/methods/files.getUploadURLExternal
- step2: "https://files.slack.com/upload/v1/..." URLs returned from files.getUploadURLExternal API
- - step3: https://api.slack.com/methods/files.completeUploadExternal
- and https://api.slack.com/methods/files.info
+ - step3: https://docs.slack.dev/reference/methods/files.completeUploadExternal
+ and https://docs.slack.dev/reference/methods/files.info
"""
if file is None and content is None and file_uploads is None:
@@ -4037,7 +4045,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets a URL for an edge external upload.
- https://api.slack.com/methods/files.getUploadURLExternal
+ https://docs.slack.dev/reference/methods/files.getUploadURLExternal
"""
kwargs.update(
{
@@ -4060,7 +4068,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Finishes an upload started with files.getUploadURLExternal.
- https://api.slack.com/methods/files.completeUploadExternal
+ https://docs.slack.dev/reference/methods/files.completeUploadExternal
"""
_files = [{k: v for k, v in f.items() if v is not None} for f in files]
kwargs.update(
@@ -4083,7 +4091,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Signal the successful completion of a function
- https://api.slack.com/methods/functions.completeSuccess
+ https://docs.slack.dev/reference/methods/functions.completeSuccess
"""
kwargs.update({"function_execution_id": function_execution_id, "outputs": json.dumps(outputs)})
return self.api_call("functions.completeSuccess", params=kwargs)
@@ -4096,7 +4104,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Signal the failure to execute a function
- https://api.slack.com/methods/functions.completeError
+ https://docs.slack.dev/reference/methods/functions.completeError
"""
kwargs.update({"function_execution_id": function_execution_id, "error": error})
return self.api_call("functions.completeError", params=kwargs)
@@ -4104,7 +4112,7 @@ Classes
# --------------------------
# Deprecated: groups.*
# You can use conversations.* APIs instead.
- # https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api
+ # https://docs.slack.dev/changelog/2020-01-deprecating-antecedents-to-the-conversations-api/
# --------------------------
def groups_archive(
@@ -4285,7 +4293,7 @@ Classes
# --------------------------
# Deprecated: im.*
# You can use conversations.* APIs instead.
- # https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api
+ # https://docs.slack.dev/changelog/2020-01-deprecating-antecedents-to-the-conversations-api/
# --------------------------
def im_close(
@@ -4361,7 +4369,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""For Enterprise Grid workspaces, map local user IDs to global user IDs
- https://api.slack.com/methods/migration.exchange
+ https://docs.slack.dev/reference/methods/migration.exchange
"""
if isinstance(users, (list, tuple)):
kwargs.update({"users": ",".join(users)})
@@ -4373,7 +4381,7 @@ Classes
# --------------------------
# Deprecated: mpim.*
# You can use conversations.* APIs instead.
- # https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api
+ # https://docs.slack.dev/changelog/2020-01-deprecating-antecedents-to-the-conversations-api/
# --------------------------
def mpim_close(
@@ -4460,7 +4468,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
- https://api.slack.com/methods/oauth.v2.access
+ https://docs.slack.dev/reference/methods/oauth.v2.access
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -4486,7 +4494,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
- https://api.slack.com/methods/oauth.access
+ https://docs.slack.dev/reference/methods/oauth.access
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -4506,7 +4514,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a legacy access token for a new expiring access token and refresh token
- https://api.slack.com/methods/oauth.v2.exchange
+ https://docs.slack.dev/reference/methods/oauth.v2.exchange
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret, "token": token})
return self.api_call("oauth.v2.exchange", params=kwargs)
@@ -4522,7 +4530,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
- https://api.slack.com/methods/openid.connect.token
+ https://docs.slack.dev/reference/methods/openid.connect.token
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -4543,7 +4551,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get the identity of a user who has authorized Sign in with Slack.
- https://api.slack.com/methods/openid.connect.userInfo
+ https://docs.slack.dev/reference/methods/openid.connect.userInfo
"""
return self.api_call("openid.connect.userInfo", params=kwargs)
@@ -4555,7 +4563,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Pins an item to a channel.
- https://api.slack.com/methods/pins.add
+ https://docs.slack.dev/reference/methods/pins.add
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
return self.api_call("pins.add", params=kwargs)
@@ -4567,7 +4575,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists items pinned to a channel.
- https://api.slack.com/methods/pins.list
+ https://docs.slack.dev/reference/methods/pins.list
"""
kwargs.update({"channel": channel})
return self.api_call("pins.list", http_verb="GET", params=kwargs)
@@ -4580,7 +4588,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Un-pins an item from a channel.
- https://api.slack.com/methods/pins.remove
+ https://docs.slack.dev/reference/methods/pins.remove
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
return self.api_call("pins.remove", params=kwargs)
@@ -4594,7 +4602,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Adds a reaction to an item.
- https://api.slack.com/methods/reactions.add
+ https://docs.slack.dev/reference/methods/reactions.add
"""
kwargs.update({"channel": channel, "name": name, "timestamp": timestamp})
return self.api_call("reactions.add", params=kwargs)
@@ -4610,7 +4618,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets reactions for an item.
- https://api.slack.com/methods/reactions.get
+ https://docs.slack.dev/reference/methods/reactions.get
"""
kwargs.update(
{
@@ -4636,7 +4644,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists reactions made by a user.
- https://api.slack.com/methods/reactions.list
+ https://docs.slack.dev/reference/methods/reactions.list
"""
kwargs.update(
{
@@ -4662,7 +4670,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Removes a reaction from an item.
- https://api.slack.com/methods/reactions.remove
+ https://docs.slack.dev/reference/methods/reactions.remove
"""
kwargs.update(
{
@@ -4686,7 +4694,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Creates a reminder.
- https://api.slack.com/methods/reminders.add
+ https://docs.slack.dev/reference/methods/reminders.add
"""
kwargs.update(
{
@@ -4707,7 +4715,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Marks a reminder as complete.
- https://api.slack.com/methods/reminders.complete
+ https://docs.slack.dev/reference/methods/reminders.complete
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.complete", params=kwargs)
@@ -4720,7 +4728,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Deletes a reminder.
- https://api.slack.com/methods/reminders.delete
+ https://docs.slack.dev/reference/methods/reminders.delete
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.delete", params=kwargs)
@@ -4733,7 +4741,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets information about a reminder.
- https://api.slack.com/methods/reminders.info
+ https://docs.slack.dev/reference/methods/reminders.info
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.info", http_verb="GET", params=kwargs)
@@ -4745,7 +4753,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists all reminders created by or for a given user.
- https://api.slack.com/methods/reminders.list
+ https://docs.slack.dev/reference/methods/reminders.list
"""
kwargs.update({"team_id": team_id})
return self.api_call("reminders.list", http_verb="GET", params=kwargs)
@@ -4758,7 +4766,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
- https://api.slack.com/methods/rtm.connect
+ https://docs.slack.dev/reference/methods/rtm.connect
"""
kwargs.update({"batch_presence_aware": batch_presence_aware, "presence_sub": presence_sub})
return self.api_call("rtm.connect", http_verb="GET", params=kwargs)
@@ -4776,7 +4784,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
- https://api.slack.com/methods/rtm.start
+ https://docs.slack.dev/reference/methods/rtm.start
"""
kwargs.update(
{
@@ -4804,7 +4812,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Searches for messages and files matching a query.
- https://api.slack.com/methods/search.all
+ https://docs.slack.dev/reference/methods/search.all
"""
kwargs.update(
{
@@ -4832,7 +4840,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Searches for files matching a query.
- https://api.slack.com/methods/search.files
+ https://docs.slack.dev/reference/methods/search.files
"""
kwargs.update(
{
@@ -4861,7 +4869,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Searches for messages matching a query.
- https://api.slack.com/methods/search.messages
+ https://docs.slack.dev/reference/methods/search.messages
"""
kwargs.update(
{
@@ -4887,7 +4895,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Adds a star to an item.
- https://api.slack.com/methods/stars.add
+ https://docs.slack.dev/reference/methods/stars.add
"""
kwargs.update(
{
@@ -4910,7 +4918,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists stars for a user.
- https://api.slack.com/methods/stars.list
+ https://docs.slack.dev/reference/methods/stars.list
"""
kwargs.update(
{
@@ -4933,7 +4941,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Removes a star from an item.
- https://api.slack.com/methods/stars.remove
+ https://docs.slack.dev/reference/methods/stars.remove
"""
kwargs.update(
{
@@ -4957,7 +4965,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets the access logs for the current team.
- https://api.slack.com/methods/team.accessLogs
+ https://docs.slack.dev/reference/methods/team.accessLogs
"""
kwargs.update(
{
@@ -4979,7 +4987,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets billable users information for the current team.
- https://api.slack.com/methods/team.billableInfo
+ https://docs.slack.dev/reference/methods/team.billableInfo
"""
kwargs.update({"team_id": team_id, "user": user})
return self.api_call("team.billableInfo", http_verb="GET", params=kwargs)
@@ -4989,7 +4997,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Reads a workspace's billing plan information.
- https://api.slack.com/methods/team.billing.info
+ https://docs.slack.dev/reference/methods/team.billing.info
"""
return self.api_call("team.billing.info", params=kwargs)
@@ -5000,7 +5008,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Disconnects an external organization.
- https://api.slack.com/methods/team.externalTeams.disconnect
+ https://docs.slack.dev/reference/methods/team.externalTeams.disconnect
"""
kwargs.update(
{
@@ -5022,7 +5030,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Returns a list of all the external teams connected and details about the connection.
- https://api.slack.com/methods/team.externalTeams.list
+ https://docs.slack.dev/reference/methods/team.externalTeams.list
"""
kwargs.update(
{
@@ -5053,7 +5061,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets information about the current team.
- https://api.slack.com/methods/team.info
+ https://docs.slack.dev/reference/methods/team.info
"""
kwargs.update({"team": team, "domain": domain})
return self.api_call("team.info", http_verb="GET", params=kwargs)
@@ -5071,7 +5079,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets the integration logs for the current team.
- https://api.slack.com/methods/team.integrationLogs
+ https://docs.slack.dev/reference/methods/team.integrationLogs
"""
kwargs.update(
{
@@ -5093,7 +5101,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve a team's profile.
- https://api.slack.com/methods/team.profile.get
+ https://docs.slack.dev/reference/methods/team.profile.get
"""
kwargs.update({"visibility": visibility})
return self.api_call("team.profile.get", http_verb="GET", params=kwargs)
@@ -5103,7 +5111,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieve a list of a workspace's team preferences.
- https://api.slack.com/methods/team.preferences.list
+ https://docs.slack.dev/reference/methods/team.preferences.list
"""
return self.api_call("team.preferences.list", params=kwargs)
@@ -5119,7 +5127,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Create a User Group
- https://api.slack.com/methods/usergroups.create
+ https://docs.slack.dev/reference/methods/usergroups.create
"""
kwargs.update(
{
@@ -5145,7 +5153,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Disable an existing User Group
- https://api.slack.com/methods/usergroups.disable
+ https://docs.slack.dev/reference/methods/usergroups.disable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
return self.api_call("usergroups.disable", params=kwargs)
@@ -5159,7 +5167,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Enable a User Group
- https://api.slack.com/methods/usergroups.enable
+ https://docs.slack.dev/reference/methods/usergroups.enable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
return self.api_call("usergroups.enable", params=kwargs)
@@ -5174,7 +5182,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all User Groups for a team
- https://api.slack.com/methods/usergroups.list
+ https://docs.slack.dev/reference/methods/usergroups.list
"""
kwargs.update(
{
@@ -5199,7 +5207,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update an existing User Group
- https://api.slack.com/methods/usergroups.update
+ https://docs.slack.dev/reference/methods/usergroups.update
"""
kwargs.update(
{
@@ -5226,7 +5234,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List all users in a User Group
- https://api.slack.com/methods/usergroups.users.list
+ https://docs.slack.dev/reference/methods/usergroups.users.list
"""
kwargs.update(
{
@@ -5247,7 +5255,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update the list of users for a User Group
- https://api.slack.com/methods/usergroups.users.update
+ https://docs.slack.dev/reference/methods/usergroups.users.update
"""
kwargs.update(
{
@@ -5274,7 +5282,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""List conversations the calling user may access.
- https://api.slack.com/methods/users.conversations
+ https://docs.slack.dev/reference/methods/users.conversations
"""
kwargs.update(
{
@@ -5296,7 +5304,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Delete the user profile photo
- https://api.slack.com/methods/users.deletePhoto
+ https://docs.slack.dev/reference/methods/users.deletePhoto
"""
return self.api_call("users.deletePhoto", http_verb="GET", params=kwargs)
@@ -5307,7 +5315,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets user presence information.
- https://api.slack.com/methods/users.getPresence
+ https://docs.slack.dev/reference/methods/users.getPresence
"""
kwargs.update({"user": user})
return self.api_call("users.getPresence", http_verb="GET", params=kwargs)
@@ -5317,7 +5325,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Get a user's identity.
- https://api.slack.com/methods/users.identity
+ https://docs.slack.dev/reference/methods/users.identity
"""
return self.api_call("users.identity", http_verb="GET", params=kwargs)
@@ -5329,7 +5337,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Gets information about a user.
- https://api.slack.com/methods/users.info
+ https://docs.slack.dev/reference/methods/users.info
"""
kwargs.update({"user": user, "include_locale": include_locale})
return self.api_call("users.info", http_verb="GET", params=kwargs)
@@ -5344,7 +5352,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lists all users in a Slack team.
- https://api.slack.com/methods/users.list
+ https://docs.slack.dev/reference/methods/users.list
"""
kwargs.update(
{
@@ -5363,7 +5371,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Find a user with an email address.
- https://api.slack.com/methods/users.lookupByEmail
+ https://docs.slack.dev/reference/methods/users.lookupByEmail
"""
kwargs.update({"email": email})
return self.api_call("users.lookupByEmail", http_verb="GET", params=kwargs)
@@ -5378,7 +5386,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the user profile photo
- https://api.slack.com/methods/users.setPhoto
+ https://docs.slack.dev/reference/methods/users.setPhoto
"""
kwargs.update({"crop_w": crop_w, "crop_x": crop_x, "crop_y": crop_y})
return self.api_call("users.setPhoto", files={"image": image}, data=kwargs)
@@ -5390,7 +5398,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Manually sets user presence.
- https://api.slack.com/methods/users.setPresence
+ https://docs.slack.dev/reference/methods/users.setPresence
"""
kwargs.update({"presence": presence})
return self.api_call("users.setPresence", params=kwargs)
@@ -5401,7 +5409,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Lookup an email address to see if someone is on Slack
- https://api.slack.com/methods/users.discoverableContacts.lookup
+ https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup
"""
kwargs.update({"email": email})
return self.api_call("users.discoverableContacts.lookup", params=kwargs)
@@ -5414,7 +5422,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Retrieves a user's profile information.
- https://api.slack.com/methods/users.profile.get
+ https://docs.slack.dev/reference/methods/users.profile.get
"""
kwargs.update({"user": user, "include_labels": include_labels})
return self.api_call("users.profile.get", http_verb="GET", params=kwargs)
@@ -5429,7 +5437,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Set the profile information for a user.
- https://api.slack.com/methods/users.profile.set
+ https://docs.slack.dev/reference/methods/users.profile.set
"""
kwargs.update(
{
@@ -5452,8 +5460,8 @@ Classes
**kwargs,
) -> SlackResponse:
"""Open a view for a user.
- https://api.slack.com/methods/views.open
- See https://api.slack.com/surfaces/modals for details.
+ https://docs.slack.dev/reference/methods/views.open
+ See https://docs.slack.dev/surfaces/modals/ for details.
"""
kwargs.update({"trigger_id": trigger_id, "interactivity_pointer": interactivity_pointer})
if isinstance(view, View):
@@ -5476,9 +5484,9 @@ Classes
Push a new view onto the existing view stack by passing a view
payload and a valid trigger_id generated from an interaction
within the existing modal.
- Read the modals documentation (https://api.slack.com/surfaces/modals)
+ Read the modals documentation (https://docs.slack.dev/surfaces/modals/)
to learn more about the lifecycle and intricacies of views.
- https://api.slack.com/methods/views.push
+ https://docs.slack.dev/reference/methods/views.push
"""
kwargs.update({"trigger_id": trigger_id, "interactivity_pointer": interactivity_pointer})
if isinstance(view, View):
@@ -5501,9 +5509,9 @@ Classes
"""Update an existing view.
Update a view by passing a new view definition along with the
view_id returned in views.open or the external_id.
- See the modals documentation (https://api.slack.com/surfaces/modals#updating_views)
+ See the modals documentation (https://docs.slack.dev/surfaces/modals/#updating_views)
to learn more about updating views and avoiding race conditions with the hash argument.
- https://api.slack.com/methods/views.update
+ https://docs.slack.dev/reference/methods/views.update
"""
if isinstance(view, View):
kwargs.update({"view": view.to_dict()})
@@ -5530,8 +5538,8 @@ Classes
) -> SlackResponse:
"""Publish a static view for a User.
Create or update the view that comprises an
- app's Home tab (https://api.slack.com/surfaces/tabs)
- https://api.slack.com/methods/views.publish
+ app's Home tab (https://docs.slack.dev/surfaces/app-home/)
+ https://docs.slack.dev/reference/methods/views.publish
"""
kwargs.update({"user_id": user_id, "hash": hash})
if isinstance(view, View):
@@ -5542,6 +5550,72 @@ Classes
# NOTE: Intentionally using json for the "view" parameter
return self.api_call("views.publish", json=kwargs)
+ def workflows_featured_add(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+ ) -> SlackResponse:
+ """Add featured workflows to a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.add
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.add", params=kwargs)
+
+ def workflows_featured_list(
+ self,
+ *,
+ channel_ids: Union[str, Sequence[str]],
+ **kwargs,
+ ) -> SlackResponse:
+ """List the featured workflows for specified channels.
+ https://docs.slack.dev/reference/methods/workflows.featured.list
+ """
+ if isinstance(channel_ids, (list, tuple)):
+ kwargs.update({"channel_ids": ",".join(channel_ids)})
+ else:
+ kwargs.update({"channel_ids": channel_ids})
+ return self.api_call("workflows.featured.list", params=kwargs)
+
+ def workflows_featured_remove(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+ ) -> SlackResponse:
+ """Remove featured workflows from a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.remove
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.remove", params=kwargs)
+
+ def workflows_featured_set(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+ ) -> SlackResponse:
+ """Set featured workflows for a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.set
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.set", params=kwargs)
+
def workflows_stepCompleted(
self,
*,
@@ -5550,7 +5624,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Indicate a successful outcome of a workflow step's execution.
- https://api.slack.com/methods/workflows.stepCompleted
+ https://docs.slack.dev/reference/methods/workflows.stepCompleted
"""
kwargs.update({"workflow_step_execute_id": workflow_step_execute_id})
if outputs is not None:
@@ -5567,7 +5641,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Indicate an unsuccessful outcome of a workflow step's execution.
- https://api.slack.com/methods/workflows.stepFailed
+ https://docs.slack.dev/reference/methods/workflows.stepFailed
"""
kwargs.update(
{
@@ -5588,7 +5662,7 @@ Classes
**kwargs,
) -> SlackResponse:
"""Update the configuration for a workflow extension step.
- https://api.slack.com/methods/workflows.updateStep
+ https://docs.slack.dev/reference/methods/workflows.updateStep
"""
kwargs.update({"workflow_step_edit_id": workflow_step_edit_id})
if inputs is not None:
@@ -5600,7 +5674,7 @@ Classes
return self.api_call("workflows.updateStep", json=kwargs)A WebClient allows apps to communicate with the Slack Platform's Web API.
- +https://docs.slack.dev/reference/methods
The Slack Web API is an interface for querying information from and enacting change in a Slack workspace.
This client handles constructing and sending HTTP requests to Slack @@ -5680,7 +5754,7 @@
Retrieve analytics data for a given date, presented as a compressed JSON file -https://api.slack.com/methods/admin.analytics.getFile
def admin_apps_activities_list(self,
*,
app_id: str | None = None,
component_id: str | None = None,
component_type: str | None = None,
log_event_type: str | None = None,
max_date_created: int | None = None,
min_date_created: int | None = None,
min_log_level: str | None = None,
sort_direction: str | None = None,
source: str | None = None,
team_id: str | None = None,
trace_id: str | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -5719,7 +5793,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get logs for a specified team/org
- https://api.slack.com/methods/admin.apps.activities.list
+ https://docs.slack.dev/reference/methods/admin.apps.activities.list
"""
kwargs.update(
{
@@ -5741,7 +5815,7 @@ Methods
return self.api_call("admin.apps.activities.list", params=kwargs)
Get logs for a specified team/org -https://api.slack.com/methods/admin.apps.activities.list
def admin_apps_approve(self,
*,
app_id: str | None = None,
request_id: str | None = None,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5764,7 +5838,7 @@ Methods
Either app_id or request_id is required.
These IDs can be obtained either directly via the app_requested event,
or by the admin.apps.requests.list method.
- https://api.slack.com/methods/admin.apps.approve
+ https://docs.slack.dev/reference/methods/admin.apps.approve
"""
if app_id:
kwargs.update({"app_id": app_id})
@@ -5785,7 +5859,7 @@ Methods
Either app_id or request_id is required.
These IDs can be obtained either directly via the app_requested event,
or by the admin.apps.requests.list method.
-https://api.slack.com/methods/admin.apps.approve
def admin_apps_approved_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5805,7 +5879,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List approved apps for an org or workspace.
- https://api.slack.com/methods/admin.apps.approved.list
+ https://docs.slack.dev/reference/methods/admin.apps.approved.list
"""
kwargs.update(
{
@@ -5818,7 +5892,7 @@ Methods
return self.api_call("admin.apps.approved.list", http_verb="GET", params=kwargs)
List approved apps for an org or workspace. -https://api.slack.com/methods/admin.apps.approved.list
def admin_apps_clearResolution(self,
*,
app_id: str,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5837,7 +5911,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Clear an app resolution
- https://api.slack.com/methods/admin.apps.clearResolution
+ https://docs.slack.dev/reference/methods/admin.apps.clearResolution
"""
kwargs.update(
{
@@ -5849,7 +5923,7 @@ Methods
return self.api_call("admin.apps.clearResolution", http_verb="POST", params=kwargs)
Clear an app resolution -https://api.slack.com/methods/admin.apps.clearResolution
def admin_apps_config_lookup(self, *, app_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -5866,7 +5940,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Look up the app config for connectors by their IDs
- https://api.slack.com/methods/admin.apps.config.lookup
+ https://docs.slack.dev/reference/methods/admin.apps.config.lookup
"""
if isinstance(app_ids, (list, tuple)):
kwargs.update({"app_ids": ",".join(app_ids)})
@@ -5875,7 +5949,7 @@ Methods
return self.api_call("admin.apps.config.lookup", params=kwargs)
Look up the app config for connectors by their IDs -https://api.slack.com/methods/admin.apps.config.lookup
def admin_apps_config_set(self,
*,
app_id: str,
domain_restrictions: Dict[str, Any] | None = None,
workflow_auth_strategy: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5894,7 +5968,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the app config for a connector
- https://api.slack.com/methods/admin.apps.config.set
+ https://docs.slack.dev/reference/methods/admin.apps.config.set
"""
kwargs.update(
{
@@ -5907,7 +5981,7 @@ Methods
return self.api_call("admin.apps.config.set", params=kwargs)
Set the app config for a connector -https://api.slack.com/methods/admin.apps.config.set
def admin_apps_requests_cancel(self,
*,
request_id: str,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5926,7 +6000,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
- https://api.slack.com/methods/admin.apps.requests.cancel
+ https://docs.slack.dev/reference/methods/admin.apps.requests.cancel
"""
kwargs.update(
{
@@ -5938,7 +6012,7 @@ Methods
return self.api_call("admin.apps.requests.cancel", http_verb="POST", params=kwargs)
List app requests for a team/workspace. -https://api.slack.com/methods/admin.apps.requests.cancel
def admin_apps_requests_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5957,7 +6031,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
- https://api.slack.com/methods/admin.apps.requests.list
+ https://docs.slack.dev/reference/methods/admin.apps.requests.list
"""
kwargs.update(
{
@@ -5969,7 +6043,7 @@ Methods
return self.api_call("admin.apps.requests.list", http_verb="GET", params=kwargs)
List app requests for a team/workspace. -https://api.slack.com/methods/admin.apps.requests.list
def admin_apps_restrict(self,
*,
app_id: str | None = None,
request_id: str | None = None,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -5992,7 +6066,7 @@ Methods
Exactly one of the team_id or enterprise_id arguments is required, not both.
Either app_id or request_id is required. These IDs can be obtained either directly
via the app_requested event, or by the admin.apps.requests.list method.
- https://api.slack.com/methods/admin.apps.restrict
+ https://docs.slack.dev/reference/methods/admin.apps.restrict
"""
if app_id:
kwargs.update({"app_id": app_id})
@@ -6013,7 +6087,7 @@ Methods
Exactly one of the team_id or enterprise_id arguments is required, not both.
Either app_id or request_id is required. These IDs can be obtained either directly
via the app_requested event, or by the admin.apps.requests.list method.
-https://api.slack.com/methods/admin.apps.restrict
+https://docs.slack.dev/reference/methods/admin.apps.restrict
def admin_apps_restricted_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
enterprise_id: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -6033,7 +6107,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List restricted apps for an org or workspace.
- https://api.slack.com/methods/admin.apps.restricted.list
+ https://docs.slack.dev/reference/methods/admin.apps.restricted.list
"""
kwargs.update(
{
@@ -6046,7 +6120,7 @@ Methods
return self.api_call("admin.apps.restricted.list", http_verb="GET", params=kwargs)
List restricted apps for an org or workspace.
-https://api.slack.com/methods/admin.apps.restricted.list
+https://docs.slack.dev/reference/methods/admin.apps.restricted.list
def admin_apps_uninstall(self,
*,
app_id: str,
enterprise_id: str | None = None,
team_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -6066,7 +6140,7 @@ Methods
) -> SlackResponse:
"""Uninstall an app from one or many workspaces, or an entire enterprise organization.
With an org-level token, enterprise_id or team_ids is required.
- https://api.slack.com/methods/admin.apps.uninstall
+ https://docs.slack.dev/reference/methods/admin.apps.uninstall
"""
kwargs.update({"app_id": app_id})
if enterprise_id is not None:
@@ -6080,7 +6154,7 @@ Methods
Uninstall an app from one or many workspaces, or an entire enterprise organization.
With an org-level token, enterprise_id or team_ids is required.
-https://api.slack.com/methods/admin.apps.uninstall
+https://docs.slack.dev/reference/methods/admin.apps.uninstall
def admin_auth_policy_assignEntities(self,
*,
entity_ids: str | Sequence[str],
policy_name: str,
entity_type: str,
**kwargs) ‑> SlackResponse
@@ -6099,7 +6173,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Assign entities to a particular authentication policy.
- https://api.slack.com/methods/admin.auth.policy.assignEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.assignEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
@@ -6110,7 +6184,7 @@ Methods
return self.api_call("admin.auth.policy.assignEntities", http_verb="POST", params=kwargs)
Assign entities to a particular authentication policy.
-https://api.slack.com/methods/admin.auth.policy.assignEntities
+https://docs.slack.dev/reference/methods/admin.auth.policy.assignEntities
def admin_auth_policy_getEntities(self,
*,
policy_name: str,
cursor: str | None = None,
entity_type: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -6130,7 +6204,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Fetch all the entities assigned to a particular authentication policy by name.
- https://api.slack.com/methods/admin.auth.policy.getEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities
"""
kwargs.update({"policy_name": policy_name})
if cursor is not None:
@@ -6142,7 +6216,7 @@ Methods
return self.api_call("admin.auth.policy.getEntities", http_verb="POST", params=kwargs)
Fetch all the entities assigned to a particular authentication policy by name.
-https://api.slack.com/methods/admin.auth.policy.getEntities
+https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities
def admin_auth_policy_removeEntities(self,
*,
entity_ids: str | Sequence[str],
policy_name: str,
entity_type: str,
**kwargs) ‑> SlackResponse
@@ -6161,7 +6235,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove specified entities from a specified authentication policy.
- https://api.slack.com/methods/admin.auth.policy.removeEntities
+ https://docs.slack.dev/reference/methods/admin.auth.policy.removeEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
@@ -6172,7 +6246,7 @@ Methods
return self.api_call("admin.auth.policy.removeEntities", http_verb="POST", params=kwargs)
Remove specified entities from a specified authentication policy.
-https://api.slack.com/methods/admin.auth.policy.removeEntities
+https://docs.slack.dev/reference/methods/admin.auth.policy.removeEntities
def admin_barriers_create(self,
*,
barriered_from_usergroup_ids: str | Sequence[str],
primary_usergroup_id: str,
restricted_subjects: str | Sequence[str],
**kwargs) ‑> SlackResponse
@@ -6191,7 +6265,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create an Information Barrier
- https://api.slack.com/methods/admin.barriers.create
+ https://docs.slack.dev/reference/methods/admin.barriers.create
"""
kwargs.update({"primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
@@ -6205,7 +6279,7 @@ Methods
return self.api_call("admin.barriers.create", http_verb="POST", params=kwargs)
Create an Information Barrier
-https://api.slack.com/methods/admin.barriers.create
+https://docs.slack.dev/reference/methods/admin.barriers.create
def admin_barriers_delete(self, *, barrier_id: str, **kwargs) ‑> SlackResponse
@@ -6222,13 +6296,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Delete an existing Information Barrier
- https://api.slack.com/methods/admin.barriers.delete
+ https://docs.slack.dev/reference/methods/admin.barriers.delete
"""
kwargs.update({"barrier_id": barrier_id})
return self.api_call("admin.barriers.delete", http_verb="POST", params=kwargs)
Delete an existing Information Barrier
-https://api.slack.com/methods/admin.barriers.delete
+https://docs.slack.dev/reference/methods/admin.barriers.delete
def admin_barriers_list(self, *, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -6246,7 +6320,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get all Information Barriers for your organization
- https://api.slack.com/methods/admin.barriers.list"""
+ https://docs.slack.dev/reference/methods/admin.barriers.list"""
kwargs.update(
{
"cursor": cursor,
@@ -6256,7 +6330,7 @@ Methods
return self.api_call("admin.barriers.list", http_verb="GET", params=kwargs)
Get all Information Barriers for your organization
-https://api.slack.com/methods/admin.barriers.list
+https://docs.slack.dev/reference/methods/admin.barriers.list
def admin_barriers_update(self,
*,
barrier_id: str,
barriered_from_usergroup_ids: str | Sequence[str],
primary_usergroup_id: str,
restricted_subjects: str | Sequence[str],
**kwargs) ‑> SlackResponse
@@ -6276,7 +6350,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update an existing Information Barrier
- https://api.slack.com/methods/admin.barriers.update
+ https://docs.slack.dev/reference/methods/admin.barriers.update
"""
kwargs.update({"barrier_id": barrier_id, "primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
@@ -6290,7 +6364,7 @@ Methods
return self.api_call("admin.barriers.update", http_verb="POST", params=kwargs)
Update an existing Information Barrier
-https://api.slack.com/methods/admin.barriers.update
+https://docs.slack.dev/reference/methods/admin.barriers.update
def admin_conversations_archive(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6307,13 +6381,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Archive a public or private channel.
- https://api.slack.com/methods/admin.conversations.archive
+ https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.archive", params=kwargs)
Archive a public or private channel.
-https://api.slack.com/methods/admin.conversations.archive
+https://docs.slack.dev/reference/methods/admin.conversations.archive
def admin_conversations_bulkArchive(self, *, channel_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -6330,13 +6404,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Archive public or private channels in bulk.
- https://api.slack.com/methods/admin.conversations.bulkArchive
+ https://docs.slack.dev/reference/methods/admin.conversations.bulkArchive
"""
kwargs.update({"channel_ids": ",".join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call("admin.conversations.bulkArchive", params=kwargs)
Archive public or private channels in bulk.
-https://api.slack.com/methods/admin.conversations.bulkArchive
+https://docs.slack.dev/reference/methods/admin.conversations.bulkArchive
def admin_conversations_bulkDelete(self, *, channel_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -6377,7 +6451,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Move public or private channels in bulk.
- https://api.slack.com/methods/admin.conversations.bulkMove
+ https://docs.slack.dev/reference/methods/admin.conversations.bulkMove
"""
kwargs.update(
{
@@ -6388,7 +6462,7 @@ Methods
return self.api_call("admin.conversations.bulkMove", params=kwargs)
Move public or private channels in bulk.
-https://api.slack.com/methods/admin.conversations.bulkMove
+https://docs.slack.dev/reference/methods/admin.conversations.bulkMove
def admin_conversations_convertToPrivate(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6405,13 +6479,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Convert a public channel to a private channel.
- https://api.slack.com/methods/admin.conversations.convertToPrivate
+ https://docs.slack.dev/reference/methods/admin.conversations.convertToPrivate
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPrivate", params=kwargs)
Convert a public channel to a private channel.
-https://api.slack.com/methods/admin.conversations.convertToPrivate
+https://docs.slack.dev/reference/methods/admin.conversations.convertToPrivate
def admin_conversations_convertToPublic(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6428,13 +6502,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Convert a privte channel to a public channel.
- https://api.slack.com/methods/admin.conversations.convertToPublic
+ https://docs.slack.dev/reference/methods/admin.conversations.convertToPublic
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPublic", params=kwargs)
Convert a privte channel to a public channel.
-https://api.slack.com/methods/admin.conversations.convertToPublic
+https://docs.slack.dev/reference/methods/admin.conversations.convertToPublic
def admin_conversations_create(self,
*,
is_private: bool,
name: str,
description: str | None = None,
org_wide: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -6455,7 +6529,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create a public or private channel-based conversation.
- https://api.slack.com/methods/admin.conversations.create
+ https://docs.slack.dev/reference/methods/admin.conversations.create
"""
kwargs.update(
{
@@ -6469,7 +6543,7 @@ Methods
return self.api_call("admin.conversations.create", params=kwargs)
Create a public or private channel-based conversation.
-https://api.slack.com/methods/admin.conversations.create
+https://docs.slack.dev/reference/methods/admin.conversations.create
def admin_conversations_createForObjects(self,
*,
object_id: str,
salesforce_org_id: str,
invite_object_team: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -6488,7 +6562,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create a Salesforce channel for the corresponding object provided.
- https://api.slack.com/methods/admin.conversations.createForObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.createForObjects
"""
kwargs.update(
{"object_id": object_id, "salesforce_org_id": salesforce_org_id, "invite_object_team": invite_object_team}
@@ -6496,7 +6570,7 @@ Methods
return self.api_call("admin.conversations.createForObjects", params=kwargs)
Create a Salesforce channel for the corresponding object provided.
-https://api.slack.com/methods/admin.conversations.createForObjects
+https://docs.slack.dev/reference/methods/admin.conversations.createForObjects
def admin_conversations_delete(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6513,13 +6587,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Delete a public or private channel.
- https://api.slack.com/methods/admin.conversations.delete
+ https://docs.slack.dev/reference/methods/admin.conversations.delete
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.delete", params=kwargs)
Delete a public or private channel.
-https://api.slack.com/methods/admin.conversations.delete
+https://docs.slack.dev/reference/methods/admin.conversations.delete
def admin_conversations_disconnectShared(self,
*,
channel_id: str,
leaving_team_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -6537,7 +6611,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Disconnect a connected channel from one or more workspaces.
- https://api.slack.com/methods/admin.conversations.disconnectShared
+ https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared
"""
kwargs.update({"channel_id": channel_id})
if isinstance(leaving_team_ids, (list, tuple)):
@@ -6547,7 +6621,7 @@ Methods
return self.api_call("admin.conversations.disconnectShared", params=kwargs)
Disconnect a connected channel from one or more workspaces.
-https://api.slack.com/methods/admin.conversations.disconnectShared
+https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared
def admin_conversations_ekm_listOriginalConnectedChannelInfo(self,
*,
channel_ids: str | Sequence[str] | None = None,
cursor: str | None = None,
limit: int | None = None,
team_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -6569,7 +6643,7 @@ Methods
"""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.
- https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
+ https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
"""
kwargs.update(
{
@@ -6590,7 +6664,7 @@ Methods
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.
-https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
+https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
def admin_conversations_getConversationPrefs(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6607,13 +6681,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get conversation preferences for a public or private channel.
- https://api.slack.com/methods/admin.conversations.getConversationPrefs
+ https://docs.slack.dev/reference/methods/admin.conversations.getConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.getConversationPrefs", params=kwargs)
Get conversation preferences for a public or private channel.
-https://api.slack.com/methods/admin.conversations.getConversationPrefs
+https://docs.slack.dev/reference/methods/admin.conversations.getConversationPrefs
def admin_conversations_getCustomRetention(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6630,13 +6704,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get a channel's retention policy
- https://api.slack.com/methods/admin.conversations.getCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.getCustomRetention
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.getCustomRetention", params=kwargs)
Get a channel's retention policy
-https://api.slack.com/methods/admin.conversations.getCustomRetention
+https://docs.slack.dev/reference/methods/admin.conversations.getCustomRetention
def admin_conversations_getTeams(self,
*,
channel_id: str,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -6655,7 +6729,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a channel.
- https://api.slack.com/methods/admin.conversations.getTeams
+ https://docs.slack.dev/reference/methods/admin.conversations.getTeams
"""
kwargs.update(
{
@@ -6667,7 +6741,7 @@ Methods
return self.api_call("admin.conversations.getTeams", params=kwargs)
Set the workspaces in an Enterprise grid org that connect to a channel.
-https://api.slack.com/methods/admin.conversations.getTeams
+https://docs.slack.dev/reference/methods/admin.conversations.getTeams
def admin_conversations_invite(self, *, channel_id: str, user_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -6685,7 +6759,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Invite a user to a public or private channel.
- https://api.slack.com/methods/admin.conversations.invite
+ https://docs.slack.dev/reference/methods/admin.conversations.invite
"""
kwargs.update({"channel_id": channel_id})
if isinstance(user_ids, (list, tuple)):
@@ -6696,7 +6770,7 @@ Methods
return self.api_call("admin.conversations.invite", params=kwargs)
Invite a user to a public or private channel.
-https://api.slack.com/methods/admin.conversations.invite
+https://docs.slack.dev/reference/methods/admin.conversations.invite
def admin_conversations_linkObjects(self, *, channel: str, record_id: str, salesforce_org_id: str, **kwargs) ‑> SlackResponse
@@ -6715,7 +6789,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Link a Salesforce record to a channel.
- https://api.slack.com/methods/admin.conversations.linkObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.linkObjects
"""
kwargs.update(
{
@@ -6727,7 +6801,7 @@ Methods
return self.api_call("admin.conversations.linkObjects", params=kwargs)
Link a Salesforce record to a channel.
-https://api.slack.com/methods/admin.conversations.linkObjects
+https://docs.slack.dev/reference/methods/admin.conversations.linkObjects
def admin_conversations_lookup(self,
*,
last_message_activity_before: int,
team_ids: str | Sequence[str],
cursor: str | None = None,
limit: int | None = None,
max_member_count: int | None = None,
**kwargs) ‑> SlackResponse
@@ -6748,7 +6822,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Returns channels on the given team using the filters.
- https://api.slack.com/methods/admin.conversations.lookup
+ https://docs.slack.dev/reference/methods/admin.conversations.lookup
"""
kwargs.update(
{
@@ -6765,7 +6839,7 @@ Methods
return self.api_call("admin.conversations.lookup", params=kwargs)
Returns channels on the given team using the filters.
-https://api.slack.com/methods/admin.conversations.lookup
+https://docs.slack.dev/reference/methods/admin.conversations.lookup
def admin_conversations_removeCustomRetention(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -6782,13 +6856,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove a channel's retention policy
- https://api.slack.com/methods/admin.conversations.removeCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.removeCustomRetention
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.removeCustomRetention", params=kwargs)
Remove a channel's retention policy
-https://api.slack.com/methods/admin.conversations.removeCustomRetention
+https://docs.slack.dev/reference/methods/admin.conversations.removeCustomRetention
def admin_conversations_rename(self, *, channel_id: str, name: str, **kwargs) ‑> SlackResponse
@@ -6806,13 +6880,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Rename a public or private channel.
- https://api.slack.com/methods/admin.conversations.rename
+ https://docs.slack.dev/reference/methods/admin.conversations.rename
"""
kwargs.update({"channel_id": channel_id, "name": name})
return self.api_call("admin.conversations.rename", params=kwargs)
Rename a public or private channel.
-https://api.slack.com/methods/admin.conversations.rename
+https://docs.slack.dev/reference/methods/admin.conversations.rename
def admin_conversations_restrictAccess_addGroup(self, *, channel_id: str, group_id: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -6831,7 +6905,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add an allowlist of IDP groups for accessing a channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup
"""
kwargs.update(
{
@@ -6847,7 +6921,7 @@ Methods
)
Add an allowlist of IDP groups for accessing a channel.
-https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
+https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup
def admin_conversations_restrictAccess_listGroups(self, *, channel_id: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -6865,7 +6939,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all IDP Groups linked to a channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups
"""
kwargs.update(
{
@@ -6880,7 +6954,7 @@ Methods
)
List all IDP Groups linked to a channel.
-https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
+https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups
def admin_conversations_restrictAccess_removeGroup(self, *, channel_id: str, group_id: str, team_id: str, **kwargs) ‑> SlackResponse
@@ -6899,7 +6973,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove a linked IDP group linked from a private channel.
- https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
+ https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.removeGroup
"""
kwargs.update(
{
@@ -6915,7 +6989,7 @@ Methods
)
Remove a linked IDP group linked from a private channel.
-https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
+https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.removeGroup
def admin_conversations_search(self,
*,
cursor: str | None = None,
limit: int | None = None,
query: str | None = None,
search_channel_types: str | Sequence[str] | None = None,
sort: str | None = None,
sort_dir: str | None = None,
team_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -6938,7 +7012,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Search for public or private channels in an Enterprise organization.
- https://api.slack.com/methods/admin.conversations.search
+ https://docs.slack.dev/reference/methods/admin.conversations.search
"""
kwargs.update(
{
@@ -6963,7 +7037,7 @@ Methods
return self.api_call("admin.conversations.search", params=kwargs)
Search for public or private channels in an Enterprise organization.
-https://api.slack.com/methods/admin.conversations.search
+https://docs.slack.dev/reference/methods/admin.conversations.search
def admin_conversations_setConversationPrefs(self, *, channel_id: str, prefs: str | Dict[str, str], **kwargs) ‑> SlackResponse
@@ -6981,7 +7055,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the posting permissions for a public or private channel.
- https://api.slack.com/methods/admin.conversations.setConversationPrefs
+ https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
if isinstance(prefs, dict):
@@ -6991,7 +7065,7 @@ Methods
return self.api_call("admin.conversations.setConversationPrefs", params=kwargs)
Set the posting permissions for a public or private channel.
-https://api.slack.com/methods/admin.conversations.setConversationPrefs
+https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs
def admin_conversations_setCustomRetention(self, *, channel_id: str, duration_days: int, **kwargs) ‑> SlackResponse
@@ -7009,13 +7083,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set a channel's retention policy
- https://api.slack.com/methods/admin.conversations.setCustomRetention
+ https://docs.slack.dev/reference/methods/admin.conversations.setCustomRetention
"""
kwargs.update({"channel_id": channel_id, "duration_days": duration_days})
return self.api_call("admin.conversations.setCustomRetention", params=kwargs)
Set a channel's retention policy
-https://api.slack.com/methods/admin.conversations.setCustomRetention
+https://docs.slack.dev/reference/methods/admin.conversations.setCustomRetention
def admin_conversations_setTeams(self,
*,
channel_id: str,
org_channel: bool | None = None,
target_team_ids: str | Sequence[str] | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7035,7 +7109,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a public or private channel.
- https://api.slack.com/methods/admin.conversations.setTeams
+ https://docs.slack.dev/reference/methods/admin.conversations.setTeams
"""
kwargs.update(
{
@@ -7051,7 +7125,7 @@ Methods
return self.api_call("admin.conversations.setTeams", params=kwargs)
Set the workspaces in an Enterprise grid org that connect to a public or private channel.
-https://api.slack.com/methods/admin.conversations.setTeams
+https://docs.slack.dev/reference/methods/admin.conversations.setTeams
def admin_conversations_unarchive(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -7068,13 +7142,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Unarchive a public or private channel.
- https://api.slack.com/methods/admin.conversations.archive
+ https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.unarchive", params=kwargs)
Unarchive a public or private channel.
-https://api.slack.com/methods/admin.conversations.archive
+https://docs.slack.dev/reference/methods/admin.conversations.archive
def admin_conversations_unlinkObjects(self, *, channel: str, new_name: str, **kwargs) ‑> SlackResponse
@@ -7092,7 +7166,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Unlink a Salesforce record from a channel.
- https://api.slack.com/methods/admin.conversations.unlinkObjects
+ https://docs.slack.dev/reference/methods/admin.conversations.unlinkObjects
"""
kwargs.update(
{
@@ -7103,7 +7177,7 @@ Methods
return self.api_call("admin.conversations.unlinkObjects", params=kwargs)
Unlink a Salesforce record from a channel.
-https://api.slack.com/methods/admin.conversations.unlinkObjects
+https://docs.slack.dev/reference/methods/admin.conversations.unlinkObjects
def admin_emoji_add(self, *, name: str, url: str, **kwargs) ‑> SlackResponse
@@ -7121,13 +7195,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add an emoji.
- https://api.slack.com/methods/admin.emoji.add
+ https://docs.slack.dev/reference/methods/admin.emoji.add
"""
kwargs.update({"name": name, "url": url})
return self.api_call("admin.emoji.add", http_verb="GET", params=kwargs)
Add an emoji.
-https://api.slack.com/methods/admin.emoji.add
+https://docs.slack.dev/reference/methods/admin.emoji.add
def admin_emoji_addAlias(self, *, alias_for: str, name: str, **kwargs) ‑> SlackResponse
@@ -7145,13 +7219,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add an emoji alias.
- https://api.slack.com/methods/admin.emoji.addAlias
+ https://docs.slack.dev/reference/methods/admin.emoji.addAlias
"""
kwargs.update({"alias_for": alias_for, "name": name})
return self.api_call("admin.emoji.addAlias", http_verb="GET", params=kwargs)
Add an emoji alias.
-https://api.slack.com/methods/admin.emoji.addAlias
+https://docs.slack.dev/reference/methods/admin.emoji.addAlias
def admin_emoji_list(self, *, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -7169,13 +7243,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""List emoji for an Enterprise Grid organization.
- https://api.slack.com/methods/admin.emoji.list
+ https://docs.slack.dev/reference/methods/admin.emoji.list
"""
kwargs.update({"cursor": cursor, "limit": limit})
return self.api_call("admin.emoji.list", http_verb="GET", params=kwargs)
List emoji for an Enterprise Grid organization.
-https://api.slack.com/methods/admin.emoji.list
+https://docs.slack.dev/reference/methods/admin.emoji.list
def admin_emoji_remove(self, *, name: str, **kwargs) ‑> SlackResponse
@@ -7192,13 +7266,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove an emoji across an Enterprise Grid organization.
- https://api.slack.com/methods/admin.emoji.remove
+ https://docs.slack.dev/reference/methods/admin.emoji.remove
"""
kwargs.update({"name": name})
return self.api_call("admin.emoji.remove", http_verb="GET", params=kwargs)
Remove an emoji across an Enterprise Grid organization.
-https://api.slack.com/methods/admin.emoji.remove
+https://docs.slack.dev/reference/methods/admin.emoji.remove
def admin_emoji_rename(self, *, name: str, new_name: str, **kwargs) ‑> SlackResponse
@@ -7216,13 +7290,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Rename an emoji.
- https://api.slack.com/methods/admin.emoji.rename
+ https://docs.slack.dev/reference/methods/admin.emoji.rename
"""
kwargs.update({"name": name, "new_name": new_name})
return self.api_call("admin.emoji.rename", http_verb="GET", params=kwargs)
Rename an emoji.
-https://api.slack.com/methods/admin.emoji.rename
+https://docs.slack.dev/reference/methods/admin.emoji.rename
def admin_functions_list(self,
*,
app_ids: str | Sequence[str],
team_id: str | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -7242,7 +7316,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Look up functions by a set of apps
- https://api.slack.com/methods/admin.functions.list
+ https://docs.slack.dev/reference/methods/admin.functions.list
"""
if isinstance(app_ids, (list, tuple)):
kwargs.update({"app_ids": ",".join(app_ids)})
@@ -7258,7 +7332,7 @@ Methods
return self.api_call("admin.functions.list", params=kwargs)
Look up functions by a set of apps
-https://api.slack.com/methods/admin.functions.list
+https://docs.slack.dev/reference/methods/admin.functions.list
def admin_functions_permissions_lookup(self, *, function_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -7276,7 +7350,7 @@ Methods
) -> SlackResponse:
"""Lookup the visibility of multiple Slack functions
and include the users if it is limited to particular named entities.
- https://api.slack.com/methods/admin.functions.permissions.lookup
+ https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup
"""
if isinstance(function_ids, (list, tuple)):
kwargs.update({"function_ids": ",".join(function_ids)})
@@ -7286,7 +7360,7 @@ Methods
Lookup the visibility of multiple Slack functions
and include the users if it is limited to particular named entities.
-https://api.slack.com/methods/admin.functions.permissions.lookup
+https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup
def admin_functions_permissions_set(self,
*,
function_id: str,
visibility: str,
user_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -7306,7 +7380,7 @@ Methods
) -> SlackResponse:
"""Set the visibility of a Slack function
and define the users or workspaces if it is set to named_entities
- https://api.slack.com/methods/admin.functions.permissions.set
+ https://docs.slack.dev/reference/methods/admin.functions.permissions.set
"""
kwargs.update(
{
@@ -7323,7 +7397,7 @@ Methods
Set the visibility of a Slack function
and define the users or workspaces if it is set to named_entities
-https://api.slack.com/methods/admin.functions.permissions.set
+https://docs.slack.dev/reference/methods/admin.functions.permissions.set
def admin_inviteRequests_approve(self, *, invite_request_id: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -7341,13 +7415,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Approve a workspace invite request.
- https://api.slack.com/methods/admin.inviteRequests.approve
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.approve
"""
kwargs.update({"invite_request_id": invite_request_id, "team_id": team_id})
return self.api_call("admin.inviteRequests.approve", params=kwargs)
Approve a workspace invite request.
-https://api.slack.com/methods/admin.inviteRequests.approve
+https://docs.slack.dev/reference/methods/admin.inviteRequests.approve
def admin_inviteRequests_approved_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7366,7 +7440,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all approved workspace invite requests.
- https://api.slack.com/methods/admin.inviteRequests.approved.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.approved.list
"""
kwargs.update(
{
@@ -7378,7 +7452,7 @@ Methods
return self.api_call("admin.inviteRequests.approved.list", params=kwargs)
List all approved workspace invite requests.
-https://api.slack.com/methods/admin.inviteRequests.approved.list
+https://docs.slack.dev/reference/methods/admin.inviteRequests.approved.list
def admin_inviteRequests_denied_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7397,7 +7471,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all denied workspace invite requests.
- https://api.slack.com/methods/admin.inviteRequests.denied.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.denied.list
"""
kwargs.update(
{
@@ -7409,7 +7483,7 @@ Methods
return self.api_call("admin.inviteRequests.denied.list", params=kwargs)
List all denied workspace invite requests.
-https://api.slack.com/methods/admin.inviteRequests.denied.list
+https://docs.slack.dev/reference/methods/admin.inviteRequests.denied.list
def admin_inviteRequests_deny(self, *, invite_request_id: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -7427,13 +7501,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deny a workspace invite request.
- https://api.slack.com/methods/admin.inviteRequests.deny
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.deny
"""
kwargs.update({"invite_request_id": invite_request_id, "team_id": team_id})
return self.api_call("admin.inviteRequests.deny", params=kwargs)
Deny a workspace invite request.
-https://api.slack.com/methods/admin.inviteRequests.deny
+https://docs.slack.dev/reference/methods/admin.inviteRequests.deny
def admin_inviteRequests_list(self, **kwargs) ‑> SlackResponse
@@ -7469,7 +7543,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Adds members to the specified role with the specified scopes
- https://api.slack.com/methods/admin.roles.addAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.addAssignments
"""
kwargs.update({"role_id": role_id})
if isinstance(entity_ids, (list, tuple)):
@@ -7483,7 +7557,7 @@ Methods
return self.api_call("admin.roles.addAssignments", params=kwargs)
Adds members to the specified role with the specified scopes
-https://api.slack.com/methods/admin.roles.addAssignments
+https://docs.slack.dev/reference/methods/admin.roles.addAssignments
def admin_roles_listAssignments(self,
*,
role_ids: str | Sequence[str] | None = None,
entity_ids: str | Sequence[str] | None = None,
cursor: str | None = None,
limit: str | int | None = None,
sort_dir: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7505,7 +7579,7 @@ Methods
) -> SlackResponse:
"""Lists assignments for all roles across entities.
Options to scope results by any combination of roles or entities
- https://api.slack.com/methods/admin.roles.listAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.listAssignments
"""
kwargs.update({"cursor": cursor, "limit": limit, "sort_dir": sort_dir})
if isinstance(entity_ids, (list, tuple)):
@@ -7520,7 +7594,7 @@ Methods
Lists assignments for all roles across entities.
Options to scope results by any combination of roles or entities
-https://api.slack.com/methods/admin.roles.listAssignments
+https://docs.slack.dev/reference/methods/admin.roles.listAssignments
def admin_roles_removeAssignments(self,
*,
role_id: str,
entity_ids: str | Sequence[str],
user_ids: str | Sequence[str],
**kwargs) ‑> SlackResponse
@@ -7539,7 +7613,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Removes a set of users from a role for the given scopes and entities
- https://api.slack.com/methods/admin.roles.removeAssignments
+ https://docs.slack.dev/reference/methods/admin.roles.removeAssignments
"""
kwargs.update({"role_id": role_id})
if isinstance(entity_ids, (list, tuple)):
@@ -7553,7 +7627,7 @@ Methods
return self.api_call("admin.roles.removeAssignments", params=kwargs)
Removes a set of users from a role for the given scopes and entities
-https://api.slack.com/methods/admin.roles.removeAssignments
+https://docs.slack.dev/reference/methods/admin.roles.removeAssignments
def admin_teams_admins_list(self, *, team_id: str, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -7572,7 +7646,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
- https://api.slack.com/methods/admin.inviteRequests.list
+ https://docs.slack.dev/reference/methods/admin.inviteRequests.list
"""
kwargs.update(
{
@@ -7584,7 +7658,7 @@ Methods
return self.api_call("admin.teams.admins.list", http_verb="GET", params=kwargs)
List all of the admins on a given workspace.
-https://api.slack.com/methods/admin.inviteRequests.list
+https://docs.slack.dev/reference/methods/admin.inviteRequests.list
def admin_teams_create(self,
*,
team_domain: str,
team_name: str,
team_description: str | None = None,
team_discoverability: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7604,7 +7678,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create an Enterprise team.
- https://api.slack.com/methods/admin.teams.create
+ https://docs.slack.dev/reference/methods/admin.teams.create
"""
kwargs.update(
{
@@ -7617,7 +7691,7 @@ Methods
return self.api_call("admin.teams.create", params=kwargs)
Create an Enterprise team.
-https://api.slack.com/methods/admin.teams.create
+https://docs.slack.dev/reference/methods/admin.teams.create
def admin_teams_list(self, *, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -7635,13 +7709,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all teams on an Enterprise organization.
- https://api.slack.com/methods/admin.teams.list
+ https://docs.slack.dev/reference/methods/admin.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit})
return self.api_call("admin.teams.list", params=kwargs)
List all teams on an Enterprise organization.
-https://api.slack.com/methods/admin.teams.list
+https://docs.slack.dev/reference/methods/admin.teams.list
def admin_teams_owners_list(self, *, team_id: str, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -7660,13 +7734,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
- https://api.slack.com/methods/admin.teams.owners.list
+ https://docs.slack.dev/reference/methods/admin.teams.owners.list
"""
kwargs.update({"team_id": team_id, "cursor": cursor, "limit": limit})
return self.api_call("admin.teams.owners.list", http_verb="GET", params=kwargs)
List all of the admins on a given workspace.
-https://api.slack.com/methods/admin.teams.owners.list
+https://docs.slack.dev/reference/methods/admin.teams.owners.list
def admin_teams_settings_info(self, *, team_id: str, **kwargs) ‑> SlackResponse
@@ -7683,13 +7757,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Fetch information about settings in a workspace
- https://api.slack.com/methods/admin.teams.settings.info
+ https://docs.slack.dev/reference/methods/admin.teams.settings.info
"""
kwargs.update({"team_id": team_id})
return self.api_call("admin.teams.settings.info", params=kwargs)
Fetch information about settings in a workspace
-https://api.slack.com/methods/admin.teams.settings.info
+https://docs.slack.dev/reference/methods/admin.teams.settings.info
def admin_teams_settings_setDefaultChannels(self, *, team_id: str, channel_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -7707,7 +7781,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the default channels of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setDefaultChannels
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDefaultChannels
"""
kwargs.update({"team_id": team_id})
if isinstance(channel_ids, (list, tuple)):
@@ -7717,7 +7791,7 @@ Methods
return self.api_call("admin.teams.settings.setDefaultChannels", http_verb="GET", params=kwargs)
Set the default channels of a workspace.
-https://api.slack.com/methods/admin.teams.settings.setDefaultChannels
+https://docs.slack.dev/reference/methods/admin.teams.settings.setDefaultChannels
def admin_teams_settings_setDescription(self, *, team_id: str, description: str, **kwargs) ‑> SlackResponse
@@ -7735,13 +7809,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the description of a given workspace.
- https://api.slack.com/methods/admin.teams.settings.setDescription
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDescription
"""
kwargs.update({"team_id": team_id, "description": description})
return self.api_call("admin.teams.settings.setDescription", params=kwargs)
Set the description of a given workspace.
-https://api.slack.com/methods/admin.teams.settings.setDescription
+https://docs.slack.dev/reference/methods/admin.teams.settings.setDescription
def admin_teams_settings_setDiscoverability(self, *, team_id: str, discoverability: str, **kwargs) ‑> SlackResponse
@@ -7759,13 +7833,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setDiscoverability
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setDiscoverability
"""
kwargs.update({"team_id": team_id, "discoverability": discoverability})
return self.api_call("admin.teams.settings.setDiscoverability", params=kwargs)
Sets the icon of a workspace.
-https://api.slack.com/methods/admin.teams.settings.setDiscoverability
+https://docs.slack.dev/reference/methods/admin.teams.settings.setDiscoverability
def admin_teams_settings_setIcon(self, *, team_id: str, image_url: str, **kwargs) ‑> SlackResponse
@@ -7783,13 +7857,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setIcon
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setIcon
"""
kwargs.update({"team_id": team_id, "image_url": image_url})
return self.api_call("admin.teams.settings.setIcon", http_verb="GET", params=kwargs)
Sets the icon of a workspace.
-https://api.slack.com/methods/admin.teams.settings.setIcon
+https://docs.slack.dev/reference/methods/admin.teams.settings.setIcon
def admin_teams_settings_setName(self, *, team_id: str, name: str, **kwargs) ‑> SlackResponse
@@ -7807,13 +7881,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
- https://api.slack.com/methods/admin.teams.settings.setName
+ https://docs.slack.dev/reference/methods/admin.teams.settings.setName
"""
kwargs.update({"team_id": team_id, "name": name})
return self.api_call("admin.teams.settings.setName", params=kwargs)
Sets the icon of a workspace.
-https://api.slack.com/methods/admin.teams.settings.setName
+https://docs.slack.dev/reference/methods/admin.teams.settings.setName
def admin_usergroups_addChannels(self,
*,
channel_ids: str | Sequence[str],
usergroup_id: str,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -7832,7 +7906,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.addChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.addChannels
"""
kwargs.update({"team_id": team_id, "usergroup_id": usergroup_id})
if isinstance(channel_ids, (list, tuple)):
@@ -7842,7 +7916,7 @@ Methods
return self.api_call("admin.usergroups.addChannels", params=kwargs)
Add one or more default channels to an IDP group.
-https://api.slack.com/methods/admin.usergroups.addChannels
+https://docs.slack.dev/reference/methods/admin.usergroups.addChannels
def admin_usergroups_addTeams(self,
*,
usergroup_id: str,
team_ids: str | Sequence[str],
auto_provision: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -7861,7 +7935,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Associate one or more default workspaces with an organization-wide IDP group.
- https://api.slack.com/methods/admin.usergroups.addTeams
+ https://docs.slack.dev/reference/methods/admin.usergroups.addTeams
"""
kwargs.update({"usergroup_id": usergroup_id, "auto_provision": auto_provision})
if isinstance(team_ids, (list, tuple)):
@@ -7871,7 +7945,7 @@ Methods
return self.api_call("admin.usergroups.addTeams", params=kwargs)
Associate one or more default workspaces with an organization-wide IDP group.
-https://api.slack.com/methods/admin.usergroups.addTeams
+https://docs.slack.dev/reference/methods/admin.usergroups.addTeams
def admin_usergroups_listChannels(self,
*,
usergroup_id: str,
include_num_members: bool | None = None,
team_id: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -7890,7 +7964,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.listChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.listChannels
"""
kwargs.update(
{
@@ -7902,7 +7976,7 @@ Methods
return self.api_call("admin.usergroups.listChannels", params=kwargs)
Add one or more default channels to an IDP group.
-https://api.slack.com/methods/admin.usergroups.listChannels
+https://docs.slack.dev/reference/methods/admin.usergroups.listChannels
def admin_usergroups_removeChannels(self, *, usergroup_id: str, channel_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -7920,7 +7994,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
- https://api.slack.com/methods/admin.usergroups.removeChannels
+ https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels
"""
kwargs.update({"usergroup_id": usergroup_id})
if isinstance(channel_ids, (list, tuple)):
@@ -7930,7 +8004,7 @@ Methods
return self.api_call("admin.usergroups.removeChannels", params=kwargs)
Add one or more default channels to an IDP group.
-https://api.slack.com/methods/admin.usergroups.removeChannels
+https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels
def admin_users_assign(self,
*,
team_id: str,
user_id: str,
channel_ids: str | Sequence[str] | None = None,
is_restricted: bool | None = None,
is_ultra_restricted: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -7951,7 +8025,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add an Enterprise user to a workspace.
- https://api.slack.com/methods/admin.users.assign
+ https://docs.slack.dev/reference/methods/admin.users.assign
"""
kwargs.update(
{
@@ -7968,7 +8042,7 @@ Methods
return self.api_call("admin.users.assign", params=kwargs)
Add an Enterprise user to a workspace.
-https://api.slack.com/methods/admin.users.assign
+https://docs.slack.dev/reference/methods/admin.users.assign
def admin_users_invite(self,
*,
team_id: str,
email: str,
channel_ids: str | Sequence[str],
custom_message: str | None = None,
email_password_policy_enabled: bool | None = None,
guest_expiration_ts: str | float | None = None,
is_restricted: bool | None = None,
is_ultra_restricted: bool | None = None,
real_name: str | None = None,
resend: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -7994,7 +8068,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Invite a user to a workspace.
- https://api.slack.com/methods/admin.users.invite
+ https://docs.slack.dev/reference/methods/admin.users.invite
"""
kwargs.update(
{
@@ -8016,10 +8090,10 @@ Methods
return self.api_call("admin.users.invite", params=kwargs)
Invite a user to a workspace.
-https://api.slack.com/methods/admin.users.invite
+https://docs.slack.dev/reference/methods/admin.users.invite
-def admin_users_list(self,
*,
team_id: str,
include_deactivated_user_workspaces: bool | None = None,
is_active: bool | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
+def admin_users_list(self,
*,
team_id: str | None = None,
include_deactivated_user_workspaces: bool | None = None,
is_active: bool | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -8029,7 +8103,7 @@ Methods
def admin_users_list(
self,
*,
- team_id: str,
+ team_id: Optional[str] = None,
include_deactivated_user_workspaces: Optional[bool] = None,
is_active: Optional[bool] = None,
cursor: Optional[str] = None,
@@ -8037,7 +8111,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List users on a workspace
- https://api.slack.com/methods/admin.users.list
+ https://docs.slack.dev/reference/methods/admin.users.list
"""
kwargs.update(
{
@@ -8051,7 +8125,7 @@ Methods
return self.api_call("admin.users.list", params=kwargs)
List users on a workspace
-https://api.slack.com/methods/admin.users.list
+https://docs.slack.dev/reference/methods/admin.users.list
def admin_users_remove(self, *, team_id: str, user_id: str, **kwargs) ‑> SlackResponse
@@ -8069,13 +8143,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove a user from a workspace.
- https://api.slack.com/methods/admin.users.remove
+ https://docs.slack.dev/reference/methods/admin.users.remove
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.remove", params=kwargs)
Remove a user from a workspace.
-https://api.slack.com/methods/admin.users.remove
+https://docs.slack.dev/reference/methods/admin.users.remove
def admin_users_session_clearSettings(self, *, user_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -8093,7 +8167,7 @@ Methods
) -> SlackResponse:
"""Clear user-specific session settings—the session duration
and what happens when the client closes—for a list of users.
- https://api.slack.com/methods/admin.users.session.clearSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.clearSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -8103,7 +8177,7 @@ Methods
Clear user-specific session settings—the session duration
and what happens when the client closes—for a list of users.
-https://api.slack.com/methods/admin.users.session.clearSettings
+https://docs.slack.dev/reference/methods/admin.users.session.clearSettings
def admin_users_session_getSettings(self, *, user_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -8121,7 +8195,7 @@ Methods
) -> SlackResponse:
"""Get user-specific session settings—the session duration
and what happens when the client closes—given a list of users.
- https://api.slack.com/methods/admin.users.session.getSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.getSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -8131,7 +8205,7 @@ Methods
Get user-specific session settings—the session duration
and what happens when the client closes—given a list of users.
-https://api.slack.com/methods/admin.users.session.getSettings
+https://docs.slack.dev/reference/methods/admin.users.session.getSettings
def admin_users_session_invalidate(self, *, session_id: str, team_id: str, **kwargs) ‑> SlackResponse
@@ -8149,13 +8223,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Invalidate a single session for a user by session_id.
- https://api.slack.com/methods/admin.users.session.invalidate
+ https://docs.slack.dev/reference/methods/admin.users.session.invalidate
"""
kwargs.update({"session_id": session_id, "team_id": team_id})
return self.api_call("admin.users.session.invalidate", params=kwargs)
Invalidate a single session for a user by session_id.
-https://api.slack.com/methods/admin.users.session.invalidate
+https://docs.slack.dev/reference/methods/admin.users.session.invalidate
def admin_users_session_list(self,
*,
cursor: str | None = None,
limit: int | None = None,
team_id: str | None = None,
user_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -8175,7 +8249,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists all active user sessions for an organization
- https://api.slack.com/methods/admin.users.session.list
+ https://docs.slack.dev/reference/methods/admin.users.session.list
"""
kwargs.update(
{
@@ -8188,7 +8262,7 @@ Methods
return self.api_call("admin.users.session.list", params=kwargs)
Lists all active user sessions for an organization
-https://api.slack.com/methods/admin.users.session.list
+https://docs.slack.dev/reference/methods/admin.users.session.list
def admin_users_session_reset(self,
*,
user_id: str,
mobile_only: bool | None = None,
web_only: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -8207,7 +8281,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Wipes all valid sessions on all devices for a given user.
- https://api.slack.com/methods/admin.users.session.reset
+ https://docs.slack.dev/reference/methods/admin.users.session.reset
"""
kwargs.update(
{
@@ -8219,7 +8293,7 @@ Methods
return self.api_call("admin.users.session.reset", params=kwargs)
Wipes all valid sessions on all devices for a given user.
-https://api.slack.com/methods/admin.users.session.reset
+https://docs.slack.dev/reference/methods/admin.users.session.reset
def admin_users_session_resetBulk(self,
*,
user_ids: str | Sequence[str],
mobile_only: bool | None = None,
web_only: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -8238,7 +8312,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
- https://api.slack.com/methods/admin.users.session.resetBulk
+ https://docs.slack.dev/reference/methods/admin.users.session.resetBulk
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -8253,7 +8327,7 @@ Methods
return self.api_call("admin.users.session.resetBulk", params=kwargs)
Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
-https://api.slack.com/methods/admin.users.session.resetBulk
+https://docs.slack.dev/reference/methods/admin.users.session.resetBulk
def admin_users_session_setSettings(self,
*,
user_ids: str | Sequence[str],
desktop_app_browser_quit: bool | None = None,
duration: int | None = None,
**kwargs) ‑> SlackResponse
@@ -8273,7 +8347,7 @@ Methods
) -> SlackResponse:
"""Configure the user-level session settings—the session duration
and what happens when the client closes—for one or more users.
- https://api.slack.com/methods/admin.users.session.setSettings
+ https://docs.slack.dev/reference/methods/admin.users.session.setSettings
"""
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
@@ -8289,7 +8363,7 @@ Methods
Configure the user-level session settings—the session duration
and what happens when the client closes—for one or more users.
-https://api.slack.com/methods/admin.users.session.setSettings
+https://docs.slack.dev/reference/methods/admin.users.session.setSettings
def admin_users_setAdmin(self, *, team_id: str, user_id: str, **kwargs) ‑> SlackResponse
@@ -8307,13 +8381,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or owner to be an admin user.
- https://api.slack.com/methods/admin.users.setAdmin
+ https://docs.slack.dev/reference/methods/admin.users.setAdmin
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setAdmin", params=kwargs)
Set an existing guest, regular user, or owner to be an admin user.
-https://api.slack.com/methods/admin.users.setAdmin
+https://docs.slack.dev/reference/methods/admin.users.setAdmin
def admin_users_setExpiration(self, *, expiration_ts: int, user_id: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -8332,13 +8406,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set an expiration for a guest user.
- https://api.slack.com/methods/admin.users.setExpiration
+ https://docs.slack.dev/reference/methods/admin.users.setExpiration
"""
kwargs.update({"expiration_ts": expiration_ts, "team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setExpiration", params=kwargs)
Set an expiration for a guest user.
-https://api.slack.com/methods/admin.users.setExpiration
+https://docs.slack.dev/reference/methods/admin.users.setExpiration
def admin_users_setOwner(self, *, team_id: str, user_id: str, **kwargs) ‑> SlackResponse
@@ -8356,13 +8430,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or admin user to be a workspace owner.
- https://api.slack.com/methods/admin.users.setOwner
+ https://docs.slack.dev/reference/methods/admin.users.setOwner
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setOwner", params=kwargs)
Set an existing guest, regular user, or admin user to be a workspace owner.
-https://api.slack.com/methods/admin.users.setOwner
+https://docs.slack.dev/reference/methods/admin.users.setOwner
def admin_users_setRegular(self, *, team_id: str, user_id: str, **kwargs) ‑> SlackResponse
@@ -8380,13 +8454,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set an existing guest user, admin user, or owner to be a regular user.
- https://api.slack.com/methods/admin.users.setRegular
+ https://docs.slack.dev/reference/methods/admin.users.setRegular
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
return self.api_call("admin.users.setRegular", params=kwargs)
Set an existing guest user, admin user, or owner to be a regular user.
-https://api.slack.com/methods/admin.users.setRegular
+https://docs.slack.dev/reference/methods/admin.users.setRegular
def admin_users_unsupportedVersions_export(self,
*,
date_end_of_support: str | int | None = None,
date_sessions_started: str | int | None = None,
**kwargs) ‑> SlackResponse
@@ -8405,7 +8479,7 @@ Methods
) -> SlackResponse:
"""Ask Slackbot to send you an export listing all workspace members using unsupported software,
presented as a zipped CSV file.
- https://api.slack.com/methods/admin.users.unsupportedVersions.export
+ https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export
"""
kwargs.update(
{
@@ -8417,7 +8491,7 @@ Methods
Ask Slackbot to send you an export listing all workspace members using unsupported software,
presented as a zipped CSV file.
-https://api.slack.com/methods/admin.users.unsupportedVersions.export
+https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export
def admin_workflows_collaborators_add(self,
*,
collaborator_ids: str | Sequence[str],
workflow_ids: str | Sequence[str],
**kwargs) ‑> SlackResponse
@@ -8435,7 +8509,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add collaborators to workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.collaborators.add
+ https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add
"""
if isinstance(collaborator_ids, (list, tuple)):
kwargs.update({"collaborator_ids": ",".join(collaborator_ids)})
@@ -8448,7 +8522,7 @@ Methods
return self.api_call("admin.workflows.collaborators.add", params=kwargs)
Add collaborators to workflows within the team or enterprise
-https://api.slack.com/methods/admin.workflows.collaborators.add
+https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add
def admin_workflows_collaborators_remove(self,
*,
collaborator_ids: str | Sequence[str],
workflow_ids: str | Sequence[str],
**kwargs) ‑> SlackResponse
@@ -8466,7 +8540,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove collaborators from workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.collaborators.remove
+ https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove
"""
if isinstance(collaborator_ids, (list, tuple)):
kwargs.update({"collaborator_ids": ",".join(collaborator_ids)})
@@ -8479,7 +8553,7 @@ Methods
return self.api_call("admin.workflows.collaborators.remove", params=kwargs)
Remove collaborators from workflows within the team or enterprise
-https://api.slack.com/methods/admin.workflows.collaborators.remove
+https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove
def admin_workflows_permissions_lookup(self,
*,
workflow_ids: str | Sequence[str],
max_workflow_triggers: int | None = None,
**kwargs) ‑> SlackResponse
@@ -8497,7 +8571,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Look up the permissions for a set of workflows
- https://api.slack.com/methods/admin.workflows.permissions.lookup
+ https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup
"""
if isinstance(workflow_ids, (list, tuple)):
kwargs.update({"workflow_ids": ",".join(workflow_ids)})
@@ -8511,7 +8585,7 @@ Methods
return self.api_call("admin.workflows.permissions.lookup", params=kwargs)
Look up the permissions for a set of workflows
-https://api.slack.com/methods/admin.workflows.permissions.lookup
+https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup
def admin_workflows_search(self,
*,
app_id: str | None = None,
collaborator_ids: str | Sequence[str] | None = None,
cursor: str | None = None,
limit: int | None = None,
no_collaborators: bool | None = None,
num_trigger_ids: int | None = None,
query: str | None = None,
sort: str | None = None,
sort_dir: str | None = None,
source: str | None = None,
**kwargs) ‑> SlackResponse
@@ -8537,7 +8611,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Search workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.search
+ https://docs.slack.dev/reference/methods/admin.workflows.search
"""
if collaborator_ids is not None:
if isinstance(collaborator_ids, (list, tuple)):
@@ -8560,7 +8634,7 @@ Methods
return self.api_call("admin.workflows.search", params=kwargs)
Search workflows within the team or enterprise
-https://api.slack.com/methods/admin.workflows.search
+https://docs.slack.dev/reference/methods/admin.workflows.search
def admin_workflows_unpublish(self, *, workflow_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
@@ -8577,7 +8651,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Unpublish workflows within the team or enterprise
- https://api.slack.com/methods/admin.workflows.unpublish
+ https://docs.slack.dev/reference/methods/admin.workflows.unpublish
"""
if isinstance(workflow_ids, (list, tuple)):
kwargs.update({"workflow_ids": ",".join(workflow_ids)})
@@ -8586,7 +8660,7 @@ Methods
return self.api_call("admin.workflows.unpublish", params=kwargs)
Unpublish workflows within the team or enterprise
-https://api.slack.com/methods/admin.workflows.unpublish
+https://docs.slack.dev/reference/methods/admin.workflows.unpublish
def api_test(self, *, error: str | None = None, **kwargs) ‑> SlackResponse
@@ -8603,13 +8677,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Checks API calling code.
- https://api.slack.com/methods/api.test
+ https://docs.slack.dev/reference/methods/api.test
"""
kwargs.update({"error": error})
return self.api_call("api.test", params=kwargs)
Checks API calling code.
-https://api.slack.com/methods/api.test
+https://docs.slack.dev/reference/methods/api.test
def apps_connections_open(self, *, app_token: str, **kwargs) ‑> SlackResponse
@@ -8627,14 +8701,14 @@ Methods
) -> SlackResponse:
"""Generate a temporary Socket Mode WebSocket URL that your app can connect to
in order to receive events and interactive payloads
- https://api.slack.com/methods/apps.connections.open
+ https://docs.slack.dev/reference/methods/apps.connections.open
"""
kwargs.update({"token": app_token})
return self.api_call("apps.connections.open", http_verb="POST", params=kwargs)
Generate a temporary Socket Mode WebSocket URL that your app can connect to
in order to receive events and interactive payloads
-https://api.slack.com/methods/apps.connections.open
+https://docs.slack.dev/reference/methods/apps.connections.open
def apps_event_authorizations_list(self,
*,
event_context: str,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -8654,14 +8728,14 @@ Methods
) -> SlackResponse:
"""Get a list of authorizations for the given event context.
Each authorization represents an app installation that the event is visible to.
- https://api.slack.com/methods/apps.event.authorizations.list
+ https://docs.slack.dev/reference/methods/apps.event.authorizations.list
"""
kwargs.update({"event_context": event_context, "cursor": cursor, "limit": limit})
return self.api_call("apps.event.authorizations.list", params=kwargs)
Get a list of authorizations for the given event context.
Each authorization represents an app installation that the event is visible to.
-https://api.slack.com/methods/apps.event.authorizations.list
+https://docs.slack.dev/reference/methods/apps.event.authorizations.list
def apps_manifest_create(self, *, manifest: str | Dict[str, Any], **kwargs) ‑> SlackResponse
@@ -8678,7 +8752,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create an app from an app manifest
- https://api.slack.com/methods/apps.manifest.create
+ https://docs.slack.dev/reference/methods/apps.manifest.create
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -8687,7 +8761,7 @@ Methods
return self.api_call("apps.manifest.create", params=kwargs)
Create an app from an app manifest
-https://api.slack.com/methods/apps.manifest.create
+https://docs.slack.dev/reference/methods/apps.manifest.create
def apps_manifest_delete(self, *, app_id: str, **kwargs) ‑> SlackResponse
@@ -8704,13 +8778,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Permanently deletes an app created through app manifests
- https://api.slack.com/methods/apps.manifest.delete
+ https://docs.slack.dev/reference/methods/apps.manifest.delete
"""
kwargs.update({"app_id": app_id})
return self.api_call("apps.manifest.delete", params=kwargs)
Permanently deletes an app created through app manifests
-https://api.slack.com/methods/apps.manifest.delete
+https://docs.slack.dev/reference/methods/apps.manifest.delete
def apps_manifest_export(self, *, app_id: str, **kwargs) ‑> SlackResponse
@@ -8727,13 +8801,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Export an app manifest from an existing app
- https://api.slack.com/methods/apps.manifest.export
+ https://docs.slack.dev/reference/methods/apps.manifest.export
"""
kwargs.update({"app_id": app_id})
return self.api_call("apps.manifest.export", params=kwargs)
Export an app manifest from an existing app
-https://api.slack.com/methods/apps.manifest.export
+https://docs.slack.dev/reference/methods/apps.manifest.export
def apps_manifest_update(self, *, app_id: str, manifest: str | Dict[str, Any], **kwargs) ‑> SlackResponse
@@ -8751,7 +8825,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update an app from an app manifest
- https://api.slack.com/methods/apps.manifest.update
+ https://docs.slack.dev/reference/methods/apps.manifest.update
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -8761,7 +8835,7 @@ Methods
return self.api_call("apps.manifest.update", params=kwargs)
Update an app from an app manifest
-https://api.slack.com/methods/apps.manifest.update
+https://docs.slack.dev/reference/methods/apps.manifest.update
def apps_manifest_validate(self, *, manifest: str | Dict[str, Any], app_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -8779,7 +8853,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Validate an app manifest
- https://api.slack.com/methods/apps.manifest.validate
+ https://docs.slack.dev/reference/methods/apps.manifest.validate
"""
if isinstance(manifest, str):
kwargs.update({"manifest": manifest})
@@ -8789,7 +8863,7 @@ Methods
return self.api_call("apps.manifest.validate", params=kwargs)
Validate an app manifest
-https://api.slack.com/methods/apps.manifest.validate
+https://docs.slack.dev/reference/methods/apps.manifest.validate
def apps_uninstall(self, *, client_id: str, client_secret: str, **kwargs) ‑> SlackResponse
@@ -8807,13 +8881,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Uninstalls your app from a workspace.
- https://api.slack.com/methods/apps.uninstall
+ https://docs.slack.dev/reference/methods/apps.uninstall
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret})
return self.api_call("apps.uninstall", params=kwargs)
Uninstalls your app from a workspace.
-https://api.slack.com/methods/apps.uninstall
+https://docs.slack.dev/reference/methods/apps.uninstall
def assistant_threads_setStatus(self, *, channel_id: str, thread_ts: str, status: str, **kwargs) ‑> SlackResponse
@@ -8832,13 +8906,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setStatus
+ https://docs.slack.dev/reference/methods/assistant.threads.setStatus
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "status": status})
return self.api_call("assistant.threads.setStatus", params=kwargs)
Revokes a token.
-https://api.slack.com/methods/assistant.threads.setStatus
+https://docs.slack.dev/reference/methods/assistant.threads.setStatus
def assistant_threads_setSuggestedPrompts(self,
*,
channel_id: str,
thread_ts: str,
title: str | None = None,
prompts: List[Dict[str, str]],
**kwargs) ‑> SlackResponse
@@ -8858,7 +8932,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setSuggestedPrompts
+ https://docs.slack.dev/reference/methods/assistant.threads.setSuggestedPrompts
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "prompts": prompts})
if title is not None:
@@ -8866,7 +8940,7 @@ Methods
return self.api_call("assistant.threads.setSuggestedPrompts", json=kwargs)
Revokes a token.
-https://api.slack.com/methods/assistant.threads.setSuggestedPrompts
+https://docs.slack.dev/reference/methods/assistant.threads.setSuggestedPrompts
def assistant_threads_setTitle(self, *, channel_id: str, thread_ts: str, title: str, **kwargs) ‑> SlackResponse
@@ -8885,13 +8959,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/assistant.threads.setTitle
+ https://docs.slack.dev/reference/methods/assistant.threads.setTitle
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "title": title})
return self.api_call("assistant.threads.setTitle", params=kwargs)
Revokes a token.
-https://api.slack.com/methods/assistant.threads.setTitle
+https://docs.slack.dev/reference/methods/assistant.threads.setTitle
def auth_revoke(self, *, test: bool | None = None, **kwargs) ‑> SlackResponse
@@ -8908,13 +8982,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Revokes a token.
- https://api.slack.com/methods/auth.revoke
+ https://docs.slack.dev/reference/methods/auth.revoke
"""
kwargs.update({"test": test})
return self.api_call("auth.revoke", http_verb="GET", params=kwargs)
Revokes a token.
-https://api.slack.com/methods/auth.revoke
+https://docs.slack.dev/reference/methods/auth.revoke
def auth_teams_list(self,
cursor: str | None = None,
limit: int | None = None,
include_icon: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -8932,13 +9006,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""List the workspaces a token can access.
- https://api.slack.com/methods/auth.teams.list
+ https://docs.slack.dev/reference/methods/auth.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit, "include_icon": include_icon})
return self.api_call("auth.teams.list", params=kwargs)
List the workspaces a token can access.
-https://api.slack.com/methods/auth.teams.list
+https://docs.slack.dev/reference/methods/auth.teams.list
def auth_test(self, **kwargs) ‑> SlackResponse
@@ -8953,12 +9027,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Checks authentication & identity.
- https://api.slack.com/methods/auth.test
+ https://docs.slack.dev/reference/methods/auth.test
"""
return self.api_call("auth.test", params=kwargs)
Checks authentication & identity.
-https://api.slack.com/methods/auth.test
+https://docs.slack.dev/reference/methods/auth.test
def bookmarks_add(self,
*,
channel_id: str,
title: str,
type: str,
emoji: str | None = None,
entity_id: str | None = None,
link: str | None = None,
parent_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -8981,7 +9055,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Add bookmark to a channel.
- https://api.slack.com/methods/bookmarks.add
+ https://docs.slack.dev/reference/methods/bookmarks.add
"""
kwargs.update(
{
@@ -8997,7 +9071,7 @@ Methods
return self.api_call("bookmarks.add", http_verb="POST", params=kwargs)
Add bookmark to a channel.
-https://api.slack.com/methods/bookmarks.add
+https://docs.slack.dev/reference/methods/bookmarks.add
def bookmarks_edit(self,
*,
bookmark_id: str,
channel_id: str,
emoji: str | None = None,
link: str | None = None,
title: str | None = None,
**kwargs) ‑> SlackResponse
@@ -9018,7 +9092,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Edit bookmark.
- https://api.slack.com/methods/bookmarks.edit
+ https://docs.slack.dev/reference/methods/bookmarks.edit
"""
kwargs.update(
{
@@ -9032,7 +9106,7 @@ Methods
return self.api_call("bookmarks.edit", http_verb="POST", params=kwargs)
Edit bookmark.
-https://api.slack.com/methods/bookmarks.edit
+https://docs.slack.dev/reference/methods/bookmarks.edit
def bookmarks_list(self, *, channel_id: str, **kwargs) ‑> SlackResponse
@@ -9049,13 +9123,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""List bookmark for the channel.
- https://api.slack.com/methods/bookmarks.list
+ https://docs.slack.dev/reference/methods/bookmarks.list
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("bookmarks.list", http_verb="POST", params=kwargs)
List bookmark for the channel.
-https://api.slack.com/methods/bookmarks.list
+https://docs.slack.dev/reference/methods/bookmarks.list
def bookmarks_remove(self, *, bookmark_id: str, channel_id: str, **kwargs) ‑> SlackResponse
@@ -9073,13 +9147,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove bookmark from the channel.
- https://api.slack.com/methods/bookmarks.remove
+ https://docs.slack.dev/reference/methods/bookmarks.remove
"""
kwargs.update({"bookmark_id": bookmark_id, "channel_id": channel_id})
return self.api_call("bookmarks.remove", http_verb="POST", params=kwargs)
Remove bookmark from the channel.
-https://api.slack.com/methods/bookmarks.remove
+https://docs.slack.dev/reference/methods/bookmarks.remove
def bots_info(self, *, bot: str | None = None, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -9097,13 +9171,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets information about a bot user.
- https://api.slack.com/methods/bots.info
+ https://docs.slack.dev/reference/methods/bots.info
"""
kwargs.update({"bot": bot, "team_id": team_id})
return self.api_call("bots.info", http_verb="GET", params=kwargs)
Gets information about a bot user.
-https://api.slack.com/methods/bots.info
+https://docs.slack.dev/reference/methods/bots.info
def calls_add(self,
*,
external_unique_id: str,
join_url: str,
created_by: str | None = None,
date_start: int | None = None,
desktop_app_join_url: str | None = None,
external_display_id: str | None = None,
title: str | None = None,
users: str | Sequence[Dict[str, str]] | None = None,
**kwargs) ‑> SlackResponse
@@ -9127,7 +9201,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Registers a new Call.
- https://api.slack.com/methods/calls.add
+ https://docs.slack.dev/reference/methods/calls.add
"""
kwargs.update(
{
@@ -9147,7 +9221,7 @@ Methods
return self.api_call("calls.add", http_verb="POST", params=kwargs)
Registers a new Call.
-https://api.slack.com/methods/calls.add
+https://docs.slack.dev/reference/methods/calls.add
def calls_end(self, *, id: str, duration: int | None = None, **kwargs) ‑> SlackResponse
@@ -9165,13 +9239,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Ends a Call.
- https://api.slack.com/methods/calls.end
+ https://docs.slack.dev/reference/methods/calls.end
"""
kwargs.update({"id": id, "duration": duration})
return self.api_call("calls.end", http_verb="POST", params=kwargs)
Ends a Call.
-https://api.slack.com/methods/calls.end
+https://docs.slack.dev/reference/methods/calls.end
def calls_info(self, *, id: str, **kwargs) ‑> SlackResponse
@@ -9188,13 +9262,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Returns information about a Call.
- https://api.slack.com/methods/calls.info
+ https://docs.slack.dev/reference/methods/calls.info
"""
kwargs.update({"id": id})
return self.api_call("calls.info", http_verb="POST", params=kwargs)
Returns information about a Call.
-https://api.slack.com/methods/calls.info
+https://docs.slack.dev/reference/methods/calls.info
def calls_participants_add(self, *, id: str, users: str | Sequence[Dict[str, str]], **kwargs) ‑> SlackResponse
@@ -9212,14 +9286,14 @@ Methods
**kwargs,
) -> SlackResponse:
"""Registers new participants added to a Call.
- https://api.slack.com/methods/calls.participants.add
+ https://docs.slack.dev/reference/methods/calls.participants.add
"""
kwargs.update({"id": id})
_update_call_participants(kwargs, users)
return self.api_call("calls.participants.add", http_verb="POST", params=kwargs)
Registers new participants added to a Call.
-https://api.slack.com/methods/calls.participants.add
+https://docs.slack.dev/reference/methods/calls.participants.add
def calls_participants_remove(self, *, id: str, users: str | Sequence[Dict[str, str]], **kwargs) ‑> SlackResponse
@@ -9237,14 +9311,14 @@ Methods
**kwargs,
) -> SlackResponse:
"""Registers participants removed from a Call.
- https://api.slack.com/methods/calls.participants.remove
+ https://docs.slack.dev/reference/methods/calls.participants.remove
"""
kwargs.update({"id": id})
_update_call_participants(kwargs, users)
return self.api_call("calls.participants.remove", http_verb="POST", params=kwargs)
Registers participants removed from a Call.
-https://api.slack.com/methods/calls.participants.remove
+https://docs.slack.dev/reference/methods/calls.participants.remove
def calls_update(self,
*,
id: str,
desktop_app_join_url: str | None = None,
join_url: str | None = None,
title: str | None = None,
**kwargs) ‑> SlackResponse
@@ -9264,7 +9338,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Updates information about a Call.
- https://api.slack.com/methods/calls.update
+ https://docs.slack.dev/reference/methods/calls.update
"""
kwargs.update(
{
@@ -9277,7 +9351,7 @@ Methods
return self.api_call("calls.update", http_verb="POST", params=kwargs)
Updates information about a Call.
-https://api.slack.com/methods/calls.update
+https://docs.slack.dev/reference/methods/calls.update
def canvases_access_delete(self,
*,
canvas_id: str,
channel_ids: str | Sequence[str] | None = None,
user_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -9296,7 +9370,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create a Channel Canvas for a channel
- https://api.slack.com/methods/canvases.access.delete
+ https://docs.slack.dev/reference/methods/canvases.access.delete
"""
kwargs.update({"canvas_id": canvas_id})
if channel_ids is not None:
@@ -9312,7 +9386,7 @@ Methods
return self.api_call("canvases.access.delete", params=kwargs)
Create a Channel Canvas for a channel
-https://api.slack.com/methods/canvases.access.delete
+https://docs.slack.dev/reference/methods/canvases.access.delete
def canvases_access_set(self,
*,
canvas_id: str,
access_level: str,
channel_ids: str | Sequence[str] | None = None,
user_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -9332,7 +9406,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the access level to a canvas for specified entities
- https://api.slack.com/methods/canvases.access.set
+ https://docs.slack.dev/reference/methods/canvases.access.set
"""
kwargs.update({"canvas_id": canvas_id, "access_level": access_level})
if channel_ids is not None:
@@ -9349,7 +9423,7 @@ Methods
return self.api_call("canvases.access.set", params=kwargs)
Sets the access level to a canvas for specified entities
-https://api.slack.com/methods/canvases.access.set
+https://docs.slack.dev/reference/methods/canvases.access.set
def canvases_create(self, *, title: str | None = None, document_content: Dict[str, str], **kwargs) ‑> SlackResponse
@@ -9367,13 +9441,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create Canvas for a user
- https://api.slack.com/methods/canvases.create
+ https://docs.slack.dev/reference/methods/canvases.create
"""
kwargs.update({"title": title, "document_content": document_content})
return self.api_call("canvases.create", json=kwargs)
Create Canvas for a user
-https://api.slack.com/methods/canvases.create
+https://docs.slack.dev/reference/methods/canvases.create
def canvases_delete(self, *, canvas_id: str, **kwargs) ‑> SlackResponse
@@ -9390,13 +9464,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes a canvas
- https://api.slack.com/methods/canvases.delete
+ https://docs.slack.dev/reference/methods/canvases.delete
"""
kwargs.update({"canvas_id": canvas_id})
return self.api_call("canvases.delete", params=kwargs)
Deletes a canvas
-https://api.slack.com/methods/canvases.delete
+https://docs.slack.dev/reference/methods/canvases.delete
def canvases_edit(self, *, canvas_id: str, changes: Sequence[Dict[str, Any]], **kwargs) ‑> SlackResponse
@@ -9414,13 +9488,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update an existing canvas
- https://api.slack.com/methods/canvases.edit
+ https://docs.slack.dev/reference/methods/canvases.edit
"""
kwargs.update({"canvas_id": canvas_id, "changes": changes})
return self.api_call("canvases.edit", json=kwargs)
Update an existing canvas
-https://api.slack.com/methods/canvases.edit
+https://docs.slack.dev/reference/methods/canvases.edit
def canvases_sections_lookup(self, *, canvas_id: str, criteria: Dict[str, Any], **kwargs) ‑> SlackResponse
@@ -9438,13 +9512,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Find sections matching the provided criteria
- https://api.slack.com/methods/canvases.sections.lookup
+ https://docs.slack.dev/reference/methods/canvases.sections.lookup
"""
kwargs.update({"canvas_id": canvas_id, "criteria": json.dumps(criteria)})
return self.api_call("canvases.sections.lookup", params=kwargs)
Find sections matching the provided criteria
-https://api.slack.com/methods/canvases.sections.lookup
+https://docs.slack.dev/reference/methods/canvases.sections.lookup
def channels_archive(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -9778,13 +9852,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes a message.
- https://api.slack.com/methods/chat.delete
+ https://docs.slack.dev/reference/methods/chat.delete
"""
kwargs.update({"channel": channel, "ts": ts, "as_user": as_user})
return self.api_call("chat.delete", params=kwargs)
Deletes a message.
-https://api.slack.com/methods/chat.delete
+https://docs.slack.dev/reference/methods/chat.delete
def chat_deleteScheduledMessage(self,
*,
channel: str,
scheduled_message_id: str,
as_user: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -9803,7 +9877,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes a scheduled message.
- https://api.slack.com/methods/chat.deleteScheduledMessage
+ https://docs.slack.dev/reference/methods/chat.deleteScheduledMessage
"""
kwargs.update(
{
@@ -9815,7 +9889,7 @@ Methods
return self.api_call("chat.deleteScheduledMessage", params=kwargs)
Deletes a scheduled message.
-https://api.slack.com/methods/chat.deleteScheduledMessage
+https://docs.slack.dev/reference/methods/chat.deleteScheduledMessage
def chat_getPermalink(self, *, channel: str, message_ts: str, **kwargs) ‑> SlackResponse
@@ -9833,13 +9907,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve a permalink URL for a specific extant message
- https://api.slack.com/methods/chat.getPermalink
+ https://docs.slack.dev/reference/methods/chat.getPermalink
"""
kwargs.update({"channel": channel, "message_ts": message_ts})
return self.api_call("chat.getPermalink", http_verb="GET", params=kwargs)
Retrieve a permalink URL for a specific extant message
-https://api.slack.com/methods/chat.getPermalink
+https://docs.slack.dev/reference/methods/chat.getPermalink
def chat_meMessage(self, *, channel: str, text: str, **kwargs) ‑> SlackResponse
@@ -9857,16 +9931,16 @@ Methods
**kwargs,
) -> SlackResponse:
"""Share a me message into a channel.
- https://api.slack.com/methods/chat.meMessage
+ https://docs.slack.dev/reference/methods/chat.meMessage
"""
kwargs.update({"channel": channel, "text": text})
return self.api_call("chat.meMessage", params=kwargs)
Share a me message into a channel.
-https://api.slack.com/methods/chat.meMessage
+https://docs.slack.dev/reference/methods/chat.meMessage
-def chat_postEphemeral(self,
*,
channel: str,
user: str,
text: str | None = None,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
icon_emoji: str | None = None,
icon_url: str | None = None,
link_names: bool | None = None,
username: str | None = None,
parse: str | None = None,
**kwargs) ‑> SlackResponse
+def chat_postEphemeral(self,
*,
channel: str,
user: str,
text: str | None = None,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
icon_emoji: str | None = None,
icon_url: str | None = None,
link_names: bool | None = None,
username: str | None = None,
parse: str | None = None,
markdown_text: str | None = None,
**kwargs) ‑> SlackResponse
@@ -9888,10 +9962,11 @@ Methods
link_names: Optional[bool] = None,
username: Optional[str] = None,
parse: Optional[str] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Sends an ephemeral message to a user in a channel.
- https://api.slack.com/methods/chat.postEphemeral
+ https://docs.slack.dev/reference/methods/chat.postEphemeral
"""
kwargs.update(
{
@@ -9907,19 +9982,20 @@ Methods
"link_names": link_names,
"username": username,
"parse": parse,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.postEphemeral", kwargs)
+ _warn_if_message_text_content_is_missing("chat.postEphemeral", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.postEphemeral", json=kwargs)
Sends an ephemeral message to a user in a channel.
-https://api.slack.com/methods/chat.postEphemeral
+https://docs.slack.dev/reference/methods/chat.postEphemeral
-def chat_postMessage(self,
*,
channel: str,
text: str | None = None,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
reply_broadcast: bool | None = None,
unfurl_links: bool | None = None,
unfurl_media: bool | None = None,
container_id: str | None = None,
icon_emoji: str | None = None,
icon_url: str | None = None,
mrkdwn: bool | None = None,
link_names: bool | None = None,
username: str | None = None,
parse: str | None = None,
metadata: Dict | Metadata | None = None,
**kwargs) ‑> SlackResponse
+def chat_postMessage(self,
*,
channel: str,
text: str | None = None,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
reply_broadcast: bool | None = None,
unfurl_links: bool | None = None,
unfurl_media: bool | None = None,
container_id: str | None = None,
icon_emoji: str | None = None,
icon_url: str | None = None,
mrkdwn: bool | None = None,
link_names: bool | None = None,
username: str | None = None,
parse: str | None = None,
metadata: Dict | Metadata | None = None,
markdown_text: str | None = None,
**kwargs) ‑> SlackResponse
@@ -9946,10 +10022,11 @@ Methods
username: Optional[str] = None,
parse: Optional[str] = None, # none, full
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Sends a message to a channel.
- https://api.slack.com/methods/chat.postMessage
+ https://docs.slack.dev/reference/methods/chat.postMessage
"""
kwargs.update(
{
@@ -9970,19 +10047,20 @@ Methods
"username": username,
"parse": parse,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.postMessage", kwargs)
+ _warn_if_message_text_content_is_missing("chat.postMessage", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.postMessage", json=kwargs)
Sends a message to a channel.
-https://api.slack.com/methods/chat.postMessage
+https://docs.slack.dev/reference/methods/chat.postMessage
-def chat_scheduleMessage(self,
*,
channel: str,
post_at: str | int,
text: str,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
parse: str | None = None,
reply_broadcast: bool | None = None,
unfurl_links: bool | None = None,
unfurl_media: bool | None = None,
link_names: bool | None = None,
metadata: Dict | Metadata | None = None,
**kwargs) ‑> SlackResponse
+def chat_scheduleMessage(self,
*,
channel: str,
post_at: str | int,
text: str | None = None,
as_user: bool | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
thread_ts: str | None = None,
parse: str | None = None,
reply_broadcast: bool | None = None,
unfurl_links: bool | None = None,
unfurl_media: bool | None = None,
link_names: bool | None = None,
metadata: Dict | Metadata | None = None,
markdown_text: str | None = None,
**kwargs) ‑> SlackResponse
@@ -9994,7 +10072,7 @@ Methods
*,
channel: str,
post_at: Union[str, int],
- text: str,
+ text: Optional[str] = None,
as_user: Optional[bool] = None,
attachments: Optional[Union[str, Sequence[Union[Dict, Attachment]]]] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
@@ -10005,10 +10083,11 @@ Methods
unfurl_media: Optional[bool] = None,
link_names: Optional[bool] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Schedules a message.
- https://api.slack.com/methods/chat.scheduleMessage
+ https://docs.slack.dev/reference/methods/chat.scheduleMessage
"""
kwargs.update(
{
@@ -10025,16 +10104,17 @@ Methods
"unfurl_media": unfurl_media,
"link_names": link_names,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.scheduleMessage", kwargs)
+ _warn_if_message_text_content_is_missing("chat.scheduleMessage", kwargs)
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.scheduleMessage", json=kwargs)
Schedules a message.
-https://api.slack.com/methods/chat.scheduleMessage
+https://docs.slack.dev/reference/methods/chat.scheduleMessage
def chat_scheduledMessages_list(self,
*,
channel: str | None = None,
cursor: str | None = None,
latest: str | None = None,
limit: int | None = None,
oldest: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10056,7 +10136,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists all scheduled messages.
- https://api.slack.com/methods/chat.scheduledMessages.list
+ https://docs.slack.dev/reference/methods/chat.scheduledMessages.list
"""
kwargs.update(
{
@@ -10071,7 +10151,7 @@ Methods
return self.api_call("chat.scheduledMessages.list", params=kwargs)
Lists all scheduled messages.
-https://api.slack.com/methods/chat.scheduledMessages.list
+https://docs.slack.dev/reference/methods/chat.scheduledMessages.list
def chat_unfurl(self,
*,
channel: str | None = None,
ts: str | None = None,
source: str | None = None,
unfurl_id: str | None = None,
unfurls: Dict[str, Dict] | None = None,
user_auth_blocks: str | Sequence[Dict | Block] | None = None,
user_auth_message: str | None = None,
user_auth_required: bool | None = None,
user_auth_url: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10096,7 +10176,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Provide custom unfurl behavior for user-posted URLs.
- https://api.slack.com/methods/chat.unfurl
+ https://docs.slack.dev/reference/methods/chat.unfurl
"""
kwargs.update(
{
@@ -10117,10 +10197,10 @@ Methods
return self.api_call("chat.unfurl", json=kwargs)
Provide custom unfurl behavior for user-posted URLs.
-https://api.slack.com/methods/chat.unfurl
+https://docs.slack.dev/reference/methods/chat.unfurl
-def chat_update(self,
*,
channel: str,
ts: str,
text: str | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
as_user: bool | None = None,
file_ids: str | Sequence[str] | None = None,
link_names: bool | None = None,
parse: str | None = None,
reply_broadcast: bool | None = None,
metadata: Dict | Metadata | None = None,
**kwargs) ‑> SlackResponse
+def chat_update(self,
*,
channel: str,
ts: str,
text: str | None = None,
attachments: str | Sequence[Dict | Attachment] | None = None,
blocks: str | Sequence[Dict | Block] | None = None,
as_user: bool | None = None,
file_ids: str | Sequence[str] | None = None,
link_names: bool | None = None,
parse: str | None = None,
reply_broadcast: bool | None = None,
metadata: Dict | Metadata | None = None,
markdown_text: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10141,10 +10221,11 @@ Methods
parse: Optional[str] = None, # none, full
reply_broadcast: Optional[bool] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
+ markdown_text: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Updates a message in a channel.
- https://api.slack.com/methods/chat.update
+ https://docs.slack.dev/reference/methods/chat.update
"""
kwargs.update(
{
@@ -10158,6 +10239,7 @@ Methods
"parse": parse,
"reply_broadcast": reply_broadcast,
"metadata": metadata,
+ "markdown_text": markdown_text,
}
)
if isinstance(file_ids, (list, tuple)):
@@ -10166,12 +10248,12 @@ Methods
kwargs.update({"file_ids": file_ids})
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
- _warn_if_text_or_attachment_fallback_is_missing("chat.update", kwargs)
+ _warn_if_message_text_content_is_missing("chat.update", kwargs)
# NOTE: intentionally using json over params for API methods using blocks/attachments
return self.api_call("chat.update", json=kwargs)
Updates a message in a channel.
-https://api.slack.com/methods/chat.update
+https://docs.slack.dev/reference/methods/chat.update
def conversations_acceptSharedInvite(self,
*,
channel_name: str,
channel_id: str | None = None,
invite_id: str | None = None,
free_trial_accepted: bool | None = None,
is_private: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10193,7 +10275,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Accepts an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.acceptSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite
"""
if channel_id is None and invite_id is None:
raise e.SlackRequestError("Either channel_id or invite_id must be provided.")
@@ -10210,7 +10292,7 @@ Methods
return self.api_call("conversations.acceptSharedInvite", http_verb="POST", params=kwargs)
Accepts an invitation to a Slack Connect channel.
-https://api.slack.com/methods/conversations.acceptSharedInvite
+https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite
def conversations_approveSharedInvite(self, *, invite_id: str, target_team: str | None = None, **kwargs) ‑> SlackResponse
@@ -10228,13 +10310,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Approves an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.approveSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.approveSharedInvite
"""
kwargs.update({"invite_id": invite_id, "target_team": target_team})
return self.api_call("conversations.approveSharedInvite", http_verb="POST", params=kwargs)
Approves an invitation to a Slack Connect channel.
-https://api.slack.com/methods/conversations.approveSharedInvite
+https://docs.slack.dev/reference/methods/conversations.approveSharedInvite
def conversations_archive(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -10251,13 +10333,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Archives a conversation.
- https://api.slack.com/methods/conversations.archive
+ https://docs.slack.dev/reference/methods/conversations.archive
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.archive", params=kwargs)
Archives a conversation.
-https://api.slack.com/methods/conversations.archive
+https://docs.slack.dev/reference/methods/conversations.archive
def conversations_canvases_create(self, *, channel_id: str, document_content: Dict[str, str], **kwargs) ‑> SlackResponse
@@ -10275,13 +10357,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create a Channel Canvas for a channel
- https://api.slack.com/methods/conversations.canvases.create
+ https://docs.slack.dev/reference/methods/conversations.canvases.create
"""
kwargs.update({"channel_id": channel_id, "document_content": document_content})
return self.api_call("conversations.canvases.create", json=kwargs)
Create a Channel Canvas for a channel
-https://api.slack.com/methods/conversations.canvases.create
+https://docs.slack.dev/reference/methods/conversations.canvases.create
def conversations_close(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -10298,13 +10380,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Closes a direct message or multi-person direct message.
- https://api.slack.com/methods/conversations.close
+ https://docs.slack.dev/reference/methods/conversations.close
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.close", params=kwargs)
Closes a direct message or multi-person direct message.
-https://api.slack.com/methods/conversations.close
+https://docs.slack.dev/reference/methods/conversations.close
def conversations_create(self,
*,
name: str,
is_private: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10323,13 +10405,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Initiates a public or private channel-based conversation
- https://api.slack.com/methods/conversations.create
+ https://docs.slack.dev/reference/methods/conversations.create
"""
kwargs.update({"name": name, "is_private": is_private, "team_id": team_id})
return self.api_call("conversations.create", params=kwargs)
Initiates a public or private channel-based conversation
-https://api.slack.com/methods/conversations.create
+https://docs.slack.dev/reference/methods/conversations.create
def conversations_declineSharedInvite(self, *, invite_id: str, target_team: str | None = None, **kwargs) ‑> SlackResponse
@@ -10347,13 +10429,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Declines a Slack Connect channel invite.
- https://api.slack.com/methods/conversations.declineSharedInvite
+ https://docs.slack.dev/reference/methods/conversations.declineSharedInvite
"""
kwargs.update({"invite_id": invite_id, "target_team": target_team})
return self.api_call("conversations.declineSharedInvite", http_verb="GET", params=kwargs)
Declines a Slack Connect channel invite.
-https://api.slack.com/methods/conversations.declineSharedInvite
+https://docs.slack.dev/reference/methods/conversations.declineSharedInvite
def conversations_externalInvitePermissions_set(self, *, action: str, channel: str, target_team: str, **kwargs) ‑> SlackResponse
@@ -10367,7 +10449,7 @@ Methods
self, *, action: str, channel: str, target_team: str, **kwargs
) -> SlackResponse:
"""Sets a team in a shared External Limited channel to a shared Slack Connect channel or vice versa.
- https://api.slack.com/methods/conversations.externalInvitePermissions.set
+ https://docs.slack.dev/reference/methods/conversations.externalInvitePermissions.set
"""
kwargs.update(
{
@@ -10379,7 +10461,7 @@ Methods
return self.api_call("conversations.externalInvitePermissions.set", params=kwargs)
Sets a team in a shared External Limited channel to a shared Slack Connect channel or vice versa.
-https://api.slack.com/methods/conversations.externalInvitePermissions.set
+https://docs.slack.dev/reference/methods/conversations.externalInvitePermissions.set
def conversations_history(self,
*,
channel: str,
cursor: str | None = None,
inclusive: bool | None = None,
include_all_metadata: bool | None = None,
latest: str | None = None,
limit: int | None = None,
oldest: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10402,7 +10484,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Fetches a conversation's history of messages and events.
- https://api.slack.com/methods/conversations.history
+ https://docs.slack.dev/reference/methods/conversations.history
"""
kwargs.update(
{
@@ -10418,7 +10500,7 @@ Methods
return self.api_call("conversations.history", http_verb="GET", params=kwargs)
Fetches a conversation's history of messages and events.
-https://api.slack.com/methods/conversations.history
+https://docs.slack.dev/reference/methods/conversations.history
def conversations_info(self,
*,
channel: str,
include_locale: bool | None = None,
include_num_members: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -10437,7 +10519,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve information about a conversation.
- https://api.slack.com/methods/conversations.info
+ https://docs.slack.dev/reference/methods/conversations.info
"""
kwargs.update(
{
@@ -10449,7 +10531,7 @@ Methods
return self.api_call("conversations.info", http_verb="GET", params=kwargs)
Retrieve information about a conversation.
-https://api.slack.com/methods/conversations.info
+https://docs.slack.dev/reference/methods/conversations.info
def conversations_invite(self,
*,
channel: str,
users: str | Sequence[str],
force: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -10468,7 +10550,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Invites users to a channel.
- https://api.slack.com/methods/conversations.invite
+ https://docs.slack.dev/reference/methods/conversations.invite
"""
kwargs.update(
{
@@ -10483,7 +10565,7 @@ Methods
return self.api_call("conversations.invite", params=kwargs)
Invites users to a channel.
-https://api.slack.com/methods/conversations.invite
+https://docs.slack.dev/reference/methods/conversations.invite
def conversations_inviteShared(self,
*,
channel: str,
emails: str | Sequence[str] | None = None,
user_ids: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -10502,7 +10584,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sends an invitation to a Slack Connect channel.
- https://api.slack.com/methods/conversations.inviteShared
+ https://docs.slack.dev/reference/methods/conversations.inviteShared
"""
if emails is None and user_ids is None:
raise e.SlackRequestError("Either emails or user ids must be provided.")
@@ -10518,7 +10600,7 @@ Methods
return self.api_call("conversations.inviteShared", http_verb="GET", params=kwargs)
Sends an invitation to a Slack Connect channel.
-https://api.slack.com/methods/conversations.inviteShared
+https://docs.slack.dev/reference/methods/conversations.inviteShared
def conversations_join(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -10535,13 +10617,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Joins an existing conversation.
- https://api.slack.com/methods/conversations.join
+ https://docs.slack.dev/reference/methods/conversations.join
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.join", params=kwargs)
Joins an existing conversation.
-https://api.slack.com/methods/conversations.join
+https://docs.slack.dev/reference/methods/conversations.join
def conversations_kick(self, *, channel: str, user: str, **kwargs) ‑> SlackResponse
@@ -10559,13 +10641,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Removes a user from a conversation.
- https://api.slack.com/methods/conversations.kick
+ https://docs.slack.dev/reference/methods/conversations.kick
"""
kwargs.update({"channel": channel, "user": user})
return self.api_call("conversations.kick", params=kwargs)
Removes a user from a conversation.
-https://api.slack.com/methods/conversations.kick
+https://docs.slack.dev/reference/methods/conversations.kick
def conversations_leave(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -10582,13 +10664,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Leaves a conversation.
- https://api.slack.com/methods/conversations.leave
+ https://docs.slack.dev/reference/methods/conversations.leave
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.leave", params=kwargs)
Leaves a conversation.
-https://api.slack.com/methods/conversations.leave
+https://docs.slack.dev/reference/methods/conversations.leave
def conversations_list(self,
*,
cursor: str | None = None,
exclude_archived: bool | None = None,
limit: int | None = None,
team_id: str | None = None,
types: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -10609,7 +10691,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists all channels in a Slack team.
- https://api.slack.com/methods/conversations.list
+ https://docs.slack.dev/reference/methods/conversations.list
"""
kwargs.update(
{
@@ -10626,7 +10708,7 @@ Methods
return self.api_call("conversations.list", http_verb="GET", params=kwargs)
Lists all channels in a Slack team.
-https://api.slack.com/methods/conversations.list
+https://docs.slack.dev/reference/methods/conversations.list
def conversations_listConnectInvites(self,
*,
count: int | None = None,
cursor: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10646,14 +10728,14 @@ Methods
) -> SlackResponse:
"""List shared channel invites that have been generated
or received but have not yet been approved by all parties.
- https://api.slack.com/methods/conversations.listConnectInvites
+ https://docs.slack.dev/reference/methods/conversations.listConnectInvites
"""
kwargs.update({"count": count, "cursor": cursor, "team_id": team_id})
return self.api_call("conversations.listConnectInvites", params=kwargs)
List shared channel invites that have been generated
or received but have not yet been approved by all parties.
-https://api.slack.com/methods/conversations.listConnectInvites
+https://docs.slack.dev/reference/methods/conversations.listConnectInvites
def conversations_mark(self, *, channel: str, ts: str, **kwargs) ‑> SlackResponse
@@ -10671,13 +10753,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the read cursor in a channel.
- https://api.slack.com/methods/conversations.mark
+ https://docs.slack.dev/reference/methods/conversations.mark
"""
kwargs.update({"channel": channel, "ts": ts})
return self.api_call("conversations.mark", params=kwargs)
Sets the read cursor in a channel.
-https://api.slack.com/methods/conversations.mark
+https://docs.slack.dev/reference/methods/conversations.mark
def conversations_members(self, *, channel: str, cursor: str | None = None, limit: int | None = None, **kwargs) ‑> SlackResponse
@@ -10696,13 +10778,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve members of a conversation.
- https://api.slack.com/methods/conversations.members
+ https://docs.slack.dev/reference/methods/conversations.members
"""
kwargs.update({"channel": channel, "cursor": cursor, "limit": limit})
return self.api_call("conversations.members", http_verb="GET", params=kwargs)
Retrieve members of a conversation.
-https://api.slack.com/methods/conversations.members
+https://docs.slack.dev/reference/methods/conversations.members
def conversations_open(self,
*,
channel: str | None = None,
return_im: bool | None = None,
users: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -10721,7 +10803,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Opens or resumes a direct message or multi-person direct message.
- https://api.slack.com/methods/conversations.open
+ https://docs.slack.dev/reference/methods/conversations.open
"""
if channel is None and users is None:
raise e.SlackRequestError("Either channel or users must be provided.")
@@ -10733,7 +10815,7 @@ Methods
return self.api_call("conversations.open", params=kwargs)
Opens or resumes a direct message or multi-person direct message.
-https://api.slack.com/methods/conversations.open
+https://docs.slack.dev/reference/methods/conversations.open
def conversations_rename(self, *, channel: str, name: str, **kwargs) ‑> SlackResponse
@@ -10751,13 +10833,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Renames a conversation.
- https://api.slack.com/methods/conversations.rename
+ https://docs.slack.dev/reference/methods/conversations.rename
"""
kwargs.update({"channel": channel, "name": name})
return self.api_call("conversations.rename", params=kwargs)
Renames a conversation.
-https://api.slack.com/methods/conversations.rename
+https://docs.slack.dev/reference/methods/conversations.rename
def conversations_replies(self,
*,
channel: str,
ts: str,
cursor: str | None = None,
inclusive: bool | None = None,
include_all_metadata: bool | None = None,
latest: str | None = None,
limit: int | None = None,
oldest: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10781,7 +10863,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve a thread of messages posted to a conversation
- https://api.slack.com/methods/conversations.replies
+ https://docs.slack.dev/reference/methods/conversations.replies
"""
kwargs.update(
{
@@ -10798,7 +10880,7 @@ Methods
return self.api_call("conversations.replies", http_verb="GET", params=kwargs)
Retrieve a thread of messages posted to a conversation
-https://api.slack.com/methods/conversations.replies
+https://docs.slack.dev/reference/methods/conversations.replies
def conversations_requestSharedInvite_approve(self,
*,
invite_id: str,
channel_id: str | None = None,
is_external_limited: str | None = None,
message: Dict[str, Any] | None = None,
**kwargs) ‑> SlackResponse
@@ -10818,7 +10900,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Approve a request to add an external user to a channel. This also sends them a Slack Connect invite.
- https://api.slack.com/methods/conversations.requestSharedInvite.approve
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.approve
"""
kwargs.update(
{
@@ -10832,7 +10914,7 @@ Methods
return self.api_call("conversations.requestSharedInvite.approve", params=kwargs)
Approve a request to add an external user to a channel. This also sends them a Slack Connect invite.
-https://api.slack.com/methods/conversations.requestSharedInvite.approve
+https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.approve
def conversations_requestSharedInvite_deny(self, *, invite_id: str, message: str | None = None, **kwargs) ‑> SlackResponse
@@ -10850,13 +10932,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deny a request to invite an external user to a channel.
- https://api.slack.com/methods/conversations.requestSharedInvite.deny
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.deny
"""
kwargs.update({"invite_id": invite_id, "message": message})
return self.api_call("conversations.requestSharedInvite.deny", params=kwargs)
Deny a request to invite an external user to a channel.
-https://api.slack.com/methods/conversations.requestSharedInvite.deny
+https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.deny
def conversations_requestSharedInvite_list(self,
*,
cursor: str | None = None,
include_approved: bool | None = None,
include_denied: bool | None = None,
include_expired: bool | None = None,
invite_ids: str | Sequence[str] | None = None,
limit: int | None = None,
user_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -10879,7 +10961,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists requests to add external users to channels with ability to filter.
- https://api.slack.com/methods/conversations.requestSharedInvite.list
+ https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.list
"""
kwargs.update(
{
@@ -10899,7 +10981,7 @@ Methods
return self.api_call("conversations.requestSharedInvite.list", params=kwargs)
Lists requests to add external users to channels with ability to filter.
-https://api.slack.com/methods/conversations.requestSharedInvite.list
+https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.list
def conversations_setPurpose(self, *, channel: str, purpose: str, **kwargs) ‑> SlackResponse
@@ -10917,13 +10999,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the purpose for a conversation.
- https://api.slack.com/methods/conversations.setPurpose
+ https://docs.slack.dev/reference/methods/conversations.setPurpose
"""
kwargs.update({"channel": channel, "purpose": purpose})
return self.api_call("conversations.setPurpose", params=kwargs)
Sets the purpose for a conversation.
-https://api.slack.com/methods/conversations.setPurpose
+https://docs.slack.dev/reference/methods/conversations.setPurpose
def conversations_setTopic(self, *, channel: str, topic: str, **kwargs) ‑> SlackResponse
@@ -10941,13 +11023,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Sets the topic for a conversation.
- https://api.slack.com/methods/conversations.setTopic
+ https://docs.slack.dev/reference/methods/conversations.setTopic
"""
kwargs.update({"channel": channel, "topic": topic})
return self.api_call("conversations.setTopic", params=kwargs)
Sets the topic for a conversation.
-https://api.slack.com/methods/conversations.setTopic
+https://docs.slack.dev/reference/methods/conversations.setTopic
def conversations_unarchive(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -10964,13 +11046,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Reverses conversation archival.
- https://api.slack.com/methods/conversations.unarchive
+ https://docs.slack.dev/reference/methods/conversations.unarchive
"""
kwargs.update({"channel": channel})
return self.api_call("conversations.unarchive", params=kwargs)
Reverses conversation archival.
-https://api.slack.com/methods/conversations.unarchive
+https://docs.slack.dev/reference/methods/conversations.unarchive
def dialog_open(self, *, dialog: Dict[str, Any], trigger_id: str, **kwargs) ‑> SlackResponse
@@ -10988,7 +11070,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Open a dialog with a user.
- https://api.slack.com/methods/dialog.open
+ https://docs.slack.dev/reference/methods/dialog.open
"""
kwargs.update({"dialog": dialog, "trigger_id": trigger_id})
kwargs = _remove_none_values(kwargs)
@@ -10996,7 +11078,7 @@ Methods
return self.api_call("dialog.open", json=kwargs)
Open a dialog with a user.
-https://api.slack.com/methods/dialog.open
+https://docs.slack.dev/reference/methods/dialog.open
def dnd_endDnd(self, **kwargs) ‑> SlackResponse
@@ -11011,12 +11093,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Ends the current user's Do Not Disturb session immediately.
- https://api.slack.com/methods/dnd.endDnd
+ https://docs.slack.dev/reference/methods/dnd.endDnd
"""
return self.api_call("dnd.endDnd", params=kwargs)
Ends the current user's Do Not Disturb session immediately.
-https://api.slack.com/methods/dnd.endDnd
+https://docs.slack.dev/reference/methods/dnd.endDnd
def dnd_endSnooze(self, **kwargs) ‑> SlackResponse
@@ -11031,12 +11113,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Ends the current user's snooze mode immediately.
- https://api.slack.com/methods/dnd.endSnooze
+ https://docs.slack.dev/reference/methods/dnd.endSnooze
"""
return self.api_call("dnd.endSnooze", params=kwargs)
Ends the current user's snooze mode immediately.
-https://api.slack.com/methods/dnd.endSnooze
+https://docs.slack.dev/reference/methods/dnd.endSnooze
def dnd_info(self, *, team_id: str | None = None, user: str | None = None, **kwargs) ‑> SlackResponse
@@ -11054,13 +11136,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieves a user's current Do Not Disturb status.
- https://api.slack.com/methods/dnd.info
+ https://docs.slack.dev/reference/methods/dnd.info
"""
kwargs.update({"team_id": team_id, "user": user})
return self.api_call("dnd.info", http_verb="GET", params=kwargs)
Retrieves a user's current Do Not Disturb status.
-https://api.slack.com/methods/dnd.info
+https://docs.slack.dev/reference/methods/dnd.info
def dnd_setSnooze(self, *, num_minutes: str | int, **kwargs) ‑> SlackResponse
@@ -11077,13 +11159,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Turns on Do Not Disturb mode for the current user, or changes its duration.
- https://api.slack.com/methods/dnd.setSnooze
+ https://docs.slack.dev/reference/methods/dnd.setSnooze
"""
kwargs.update({"num_minutes": num_minutes})
return self.api_call("dnd.setSnooze", http_verb="GET", params=kwargs)
Turns on Do Not Disturb mode for the current user, or changes its duration.
-https://api.slack.com/methods/dnd.setSnooze
+https://docs.slack.dev/reference/methods/dnd.setSnooze
def dnd_teamInfo(self, users: str | Sequence[str], team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -11100,7 +11182,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieves the Do Not Disturb status for users on a team.
- https://api.slack.com/methods/dnd.teamInfo
+ https://docs.slack.dev/reference/methods/dnd.teamInfo
"""
if isinstance(users, (list, tuple)):
kwargs.update({"users": ",".join(users)})
@@ -11110,7 +11192,7 @@ Methods
return self.api_call("dnd.teamInfo", http_verb="GET", params=kwargs)
Retrieves the Do Not Disturb status for users on a team.
-https://api.slack.com/methods/dnd.teamInfo
+https://docs.slack.dev/reference/methods/dnd.teamInfo
def emoji_list(self, include_categories: bool | None = None, **kwargs) ‑> SlackResponse
@@ -11126,13 +11208,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists custom emoji for a team.
- https://api.slack.com/methods/emoji.list
+ https://docs.slack.dev/reference/methods/emoji.list
"""
kwargs.update({"include_categories": include_categories})
return self.api_call("emoji.list", http_verb="GET", params=kwargs)
Lists custom emoji for a team.
-https://api.slack.com/methods/emoji.list
+https://docs.slack.dev/reference/methods/emoji.list
def files_comments_delete(self, *, file: str, id: str, **kwargs) ‑> SlackResponse
@@ -11150,13 +11232,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes an existing comment on a file.
- https://api.slack.com/methods/files.comments.delete
+ https://docs.slack.dev/reference/methods/files.comments.delete
"""
kwargs.update({"file": file, "id": id})
return self.api_call("files.comments.delete", params=kwargs)
Deletes an existing comment on a file.
-https://api.slack.com/methods/files.comments.delete
+https://docs.slack.dev/reference/methods/files.comments.delete
def files_completeUploadExternal(self,
*,
files: List[Dict[str, str]],
channel_id: str | None = None,
channels: List[str] | None = None,
initial_comment: str | None = None,
thread_ts: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11177,7 +11259,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Finishes an upload started with files.getUploadURLExternal.
- https://api.slack.com/methods/files.completeUploadExternal
+ https://docs.slack.dev/reference/methods/files.completeUploadExternal
"""
_files = [{k: v for k, v in f.items() if v is not None} for f in files]
kwargs.update(
@@ -11193,7 +11275,7 @@ Methods
return self.api_call("files.completeUploadExternal", params=kwargs)
Finishes an upload started with files.getUploadURLExternal.
-https://api.slack.com/methods/files.completeUploadExternal
+https://docs.slack.dev/reference/methods/files.completeUploadExternal
def files_delete(self, *, file: str, **kwargs) ‑> SlackResponse
@@ -11210,13 +11292,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes a file.
- https://api.slack.com/methods/files.delete
+ https://docs.slack.dev/reference/methods/files.delete
"""
kwargs.update({"file": file})
return self.api_call("files.delete", params=kwargs)
Deletes a file.
-https://api.slack.com/methods/files.delete
+https://docs.slack.dev/reference/methods/files.delete
def files_getUploadURLExternal(self,
*,
filename: str,
length: int,
alt_txt: str | None = None,
snippet_type: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11236,7 +11318,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets a URL for an edge external upload.
- https://api.slack.com/methods/files.getUploadURLExternal
+ https://docs.slack.dev/reference/methods/files.getUploadURLExternal
"""
kwargs.update(
{
@@ -11249,7 +11331,7 @@ Methods
return self.api_call("files.getUploadURLExternal", params=kwargs)
Gets a URL for an edge external upload.
-https://api.slack.com/methods/files.getUploadURLExternal
+https://docs.slack.dev/reference/methods/files.getUploadURLExternal
def files_info(self,
*,
file: str,
count: int | None = None,
cursor: str | None = None,
limit: int | None = None,
page: int | None = None,
**kwargs) ‑> SlackResponse
@@ -11270,7 +11352,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets information about a team file.
- https://api.slack.com/methods/files.info
+ https://docs.slack.dev/reference/methods/files.info
"""
kwargs.update(
{
@@ -11284,7 +11366,7 @@ Methods
return self.api_call("files.info", http_verb="GET", params=kwargs)
Gets information about a team file.
-https://api.slack.com/methods/files.info
+https://docs.slack.dev/reference/methods/files.info
def files_list(self,
*,
channel: str | None = None,
count: int | None = None,
page: int | None = None,
show_files_hidden_by_limit: bool | None = None,
team_id: str | None = None,
ts_from: str | None = None,
ts_to: str | None = None,
types: str | Sequence[str] | None = None,
user: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11309,7 +11391,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists & filters team files.
- https://api.slack.com/methods/files.list
+ https://docs.slack.dev/reference/methods/files.list
"""
kwargs.update(
{
@@ -11330,7 +11412,7 @@ Methods
return self.api_call("files.list", http_verb="GET", params=kwargs)
Lists & filters team files.
-https://api.slack.com/methods/files.list
+https://docs.slack.dev/reference/methods/files.list
def files_remote_add(self,
*,
external_id: str,
external_url: str,
title: str,
filetype: str | None = None,
indexable_file_contents: str | bytes | io.IOBase | None = None,
preview_image: str | bytes | io.IOBase | None = None,
**kwargs) ‑> SlackResponse
@@ -11352,7 +11434,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Adds a file from a remote service.
- https://api.slack.com/methods/files.remote.add
+ https://docs.slack.dev/reference/methods/files.remote.add
"""
kwargs.update(
{
@@ -11379,7 +11461,7 @@ Methods
)
Adds a file from a remote service.
-https://api.slack.com/methods/files.remote.add
+https://docs.slack.dev/reference/methods/files.remote.add
def files_remote_info(self, *, external_id: str | None = None, file: str | None = None, **kwargs) ‑> SlackResponse
@@ -11397,13 +11479,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve information about a remote file added to Slack.
- https://api.slack.com/methods/files.remote.info
+ https://docs.slack.dev/reference/methods/files.remote.info
"""
kwargs.update({"external_id": external_id, "file": file})
return self.api_call("files.remote.info", http_verb="GET", params=kwargs)
Retrieve information about a remote file added to Slack.
-https://api.slack.com/methods/files.remote.info
+https://docs.slack.dev/reference/methods/files.remote.info
def files_remote_list(self,
*,
channel: str | None = None,
cursor: str | None = None,
limit: int | None = None,
ts_from: str | None = None,
ts_to: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11424,7 +11506,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve information about a remote file added to Slack.
- https://api.slack.com/methods/files.remote.list
+ https://docs.slack.dev/reference/methods/files.remote.list
"""
kwargs.update(
{
@@ -11438,7 +11520,7 @@ Methods
return self.api_call("files.remote.list", http_verb="GET", params=kwargs)
Retrieve information about a remote file added to Slack.
-https://api.slack.com/methods/files.remote.list
+https://docs.slack.dev/reference/methods/files.remote.list
def files_remote_remove(self, *, external_id: str | None = None, file: str | None = None, **kwargs) ‑> SlackResponse
@@ -11456,13 +11538,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Remove a remote file.
- https://api.slack.com/methods/files.remote.remove
+ https://docs.slack.dev/reference/methods/files.remote.remove
"""
kwargs.update({"external_id": external_id, "file": file})
return self.api_call("files.remote.remove", http_verb="POST", params=kwargs)
Remove a remote file.
-https://api.slack.com/methods/files.remote.remove
+https://docs.slack.dev/reference/methods/files.remote.remove
def files_remote_share(self,
*,
channels: str | Sequence[str],
external_id: str | None = None,
file: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11481,7 +11563,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Share a remote file into a channel.
- https://api.slack.com/methods/files.remote.share
+ https://docs.slack.dev/reference/methods/files.remote.share
"""
if external_id is None and file is None:
raise e.SlackRequestError("Either external_id or file must be provided.")
@@ -11493,7 +11575,7 @@ Methods
return self.api_call("files.remote.share", http_verb="GET", params=kwargs)
Share a remote file into a channel.
-https://api.slack.com/methods/files.remote.share
+https://docs.slack.dev/reference/methods/files.remote.share
def files_remote_update(self,
*,
external_id: str | None = None,
external_url: str | None = None,
file: str | None = None,
title: str | None = None,
filetype: str | None = None,
indexable_file_contents: str | None = None,
preview_image: str | None = None,
**kwargs) ‑> SlackResponse
@@ -11516,7 +11598,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Updates an existing remote file.
- https://api.slack.com/methods/files.remote.update
+ https://docs.slack.dev/reference/methods/files.remote.update
"""
kwargs.update(
{
@@ -11544,7 +11626,7 @@ Methods
)
Updates an existing remote file.
-https://api.slack.com/methods/files.remote.update
+https://docs.slack.dev/reference/methods/files.remote.update
def files_revokePublicURL(self, *, file: str, **kwargs) ‑> SlackResponse
@@ -11561,13 +11643,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Revokes public/external sharing access for a file
- https://api.slack.com/methods/files.revokePublicURL
+ https://docs.slack.dev/reference/methods/files.revokePublicURL
"""
kwargs.update({"file": file})
return self.api_call("files.revokePublicURL", params=kwargs)
Revokes public/external sharing access for a file
-https://api.slack.com/methods/files.revokePublicURL
+https://docs.slack.dev/reference/methods/files.revokePublicURL
def files_sharedPublicURL(self, *, file: str, **kwargs) ‑> SlackResponse
@@ -11584,13 +11666,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Enables a file for public/external sharing.
- https://api.slack.com/methods/files.sharedPublicURL
+ https://docs.slack.dev/reference/methods/files.sharedPublicURL
"""
kwargs.update({"file": file})
return self.api_call("files.sharedPublicURL", params=kwargs)
Enables a file for public/external sharing.
-https://api.slack.com/methods/files.sharedPublicURL
+https://docs.slack.dev/reference/methods/files.sharedPublicURL
def files_upload(self,
*,
file: str | bytes | io.IOBase | None = None,
content: str | bytes | None = None,
filename: str | None = None,
filetype: str | None = None,
initial_comment: str | None = None,
thread_ts: str | None = None,
title: str | None = None,
channels: str | Sequence[str] | None = None,
**kwargs) ‑> SlackResponse
@@ -11614,7 +11696,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Uploads or creates a file.
- https://api.slack.com/methods/files.upload
+ https://docs.slack.dev/reference/methods/files.upload
"""
_print_files_upload_v2_suggestion()
@@ -11647,7 +11729,7 @@ Methods
return self.api_call("files.upload", data=kwargs)
Uploads or creates a file.
-https://api.slack.com/methods/files.upload
+https://docs.slack.dev/reference/methods/files.upload
def files_upload_v2(self,
*,
filename: str | None = None,
file: str | bytes | io.IOBase | os.PathLike | None = None,
content: str | bytes | None = None,
title: str | None = None,
alt_txt: str | None = None,
snippet_type: str | None = None,
file_uploads: List[Dict[str, Any]] | None = None,
channel: str | None = None,
channels: List[str] | None = None,
initial_comment: str | None = None,
thread_ts: str | None = None,
request_file_info: bool = True,
**kwargs) ‑> SlackResponse
@@ -11678,12 +11760,12 @@ Methods
) -> SlackResponse:
"""This wrapper method provides an easy way to upload files using the following endpoints:
- - step1: https://api.slack.com/methods/files.getUploadURLExternal
+ - step1: https://docs.slack.dev/reference/methods/files.getUploadURLExternal
- step2: "https://files.slack.com/upload/v1/..." URLs returned from files.getUploadURLExternal API
- - step3: https://api.slack.com/methods/files.completeUploadExternal
- and https://api.slack.com/methods/files.info
+ - step3: https://docs.slack.dev/reference/methods/files.completeUploadExternal
+ and https://docs.slack.dev/reference/methods/files.info
"""
if file is None and content is None and file_uploads is None:
@@ -11762,14 +11844,14 @@ Methods
This wrapper method provides an easy way to upload files using the following endpoints:
-
-
step1: https://api.slack.com/methods/files.getUploadURLExternal
+step1: https://docs.slack.dev/reference/methods/files.getUploadURLExternal
-
step2: "https://files.slack.com/upload/v1/…" URLs returned from files.getUploadURLExternal API
-
-
step3: https://api.slack.com/methods/files.completeUploadExternal
-and https://api.slack.com/methods/files.info
+step3: https://docs.slack.dev/reference/methods/files.completeUploadExternal
+and https://docs.slack.dev/reference/methods/files.info
@@ -11789,13 +11871,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Signal the failure to execute a function
- https://api.slack.com/methods/functions.completeError
+ https://docs.slack.dev/reference/methods/functions.completeError
"""
kwargs.update({"function_execution_id": function_execution_id, "error": error})
return self.api_call("functions.completeError", params=kwargs)
Signal the failure to execute a function
-https://api.slack.com/methods/functions.completeError
+https://docs.slack.dev/reference/methods/functions.completeError
def functions_completeSuccess(self, *, function_execution_id: str, outputs: Dict[str, Any], **kwargs) ‑> SlackResponse
@@ -11813,13 +11895,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Signal the successful completion of a function
- https://api.slack.com/methods/functions.completeSuccess
+ https://docs.slack.dev/reference/methods/functions.completeSuccess
"""
kwargs.update({"function_execution_id": function_execution_id, "outputs": json.dumps(outputs)})
return self.api_call("functions.completeSuccess", params=kwargs)
Signal the successful completion of a function
-https://api.slack.com/methods/functions.completeSuccess
+https://docs.slack.dev/reference/methods/functions.completeSuccess
def groups_archive(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -12295,7 +12377,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""For Enterprise Grid workspaces, map local user IDs to global user IDs
- https://api.slack.com/methods/migration.exchange
+ https://docs.slack.dev/reference/methods/migration.exchange
"""
if isinstance(users, (list, tuple)):
kwargs.update({"users": ",".join(users)})
@@ -12305,7 +12387,7 @@ Methods
return self.api_call("migration.exchange", http_verb="GET", params=kwargs)
For Enterprise Grid workspaces, map local user IDs to global user IDs
-https://api.slack.com/methods/migration.exchange
+https://docs.slack.dev/reference/methods/migration.exchange
def mpim_close(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -12452,7 +12534,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
- https://api.slack.com/methods/oauth.access
+ https://docs.slack.dev/reference/methods/oauth.access
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -12464,7 +12546,7 @@ Methods
)
Exchanges a temporary OAuth verifier code for an access token.
-https://api.slack.com/methods/oauth.access
+https://docs.slack.dev/reference/methods/oauth.access
def oauth_v2_access(self,
*,
client_id: str,
client_secret: str,
code: str | None = None,
redirect_uri: str | None = None,
grant_type: str | None = None,
refresh_token: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12490,7 +12572,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
- https://api.slack.com/methods/oauth.v2.access
+ https://docs.slack.dev/reference/methods/oauth.v2.access
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -12507,7 +12589,7 @@ Methods
)
Exchanges a temporary OAuth verifier code for an access token.
-https://api.slack.com/methods/oauth.v2.access
+https://docs.slack.dev/reference/methods/oauth.v2.access
def oauth_v2_exchange(self, *, token: str, client_id: str, client_secret: str, **kwargs) ‑> SlackResponse
@@ -12526,13 +12608,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Exchanges a legacy access token for a new expiring access token and refresh token
- https://api.slack.com/methods/oauth.v2.exchange
+ https://docs.slack.dev/reference/methods/oauth.v2.exchange
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret, "token": token})
return self.api_call("oauth.v2.exchange", params=kwargs)
Exchanges a legacy access token for a new expiring access token and refresh token
-https://api.slack.com/methods/oauth.v2.exchange
+https://docs.slack.dev/reference/methods/oauth.v2.exchange
def openid_connect_token(self,
client_id: str,
client_secret: str,
code: str | None = None,
redirect_uri: str | None = None,
grant_type: str | None = None,
refresh_token: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12553,7 +12635,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
- https://api.slack.com/methods/openid.connect.token
+ https://docs.slack.dev/reference/methods/openid.connect.token
"""
if redirect_uri is not None:
kwargs.update({"redirect_uri": redirect_uri})
@@ -12570,7 +12652,7 @@ Methods
)
Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
-https://api.slack.com/methods/openid.connect.token
+https://docs.slack.dev/reference/methods/openid.connect.token
def openid_connect_userInfo(self, **kwargs) ‑> SlackResponse
@@ -12585,12 +12667,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get the identity of a user who has authorized Sign in with Slack.
- https://api.slack.com/methods/openid.connect.userInfo
+ https://docs.slack.dev/reference/methods/openid.connect.userInfo
"""
return self.api_call("openid.connect.userInfo", params=kwargs)
Get the identity of a user who has authorized Sign in with Slack.
-https://api.slack.com/methods/openid.connect.userInfo
+https://docs.slack.dev/reference/methods/openid.connect.userInfo
def pins_add(self, *, channel: str, timestamp: str | None = None, **kwargs) ‑> SlackResponse
@@ -12608,13 +12690,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Pins an item to a channel.
- https://api.slack.com/methods/pins.add
+ https://docs.slack.dev/reference/methods/pins.add
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
return self.api_call("pins.add", params=kwargs)
Pins an item to a channel.
-https://api.slack.com/methods/pins.add
+https://docs.slack.dev/reference/methods/pins.add
def pins_list(self, *, channel: str, **kwargs) ‑> SlackResponse
@@ -12631,13 +12713,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists items pinned to a channel.
- https://api.slack.com/methods/pins.list
+ https://docs.slack.dev/reference/methods/pins.list
"""
kwargs.update({"channel": channel})
return self.api_call("pins.list", http_verb="GET", params=kwargs)
Lists items pinned to a channel.
-https://api.slack.com/methods/pins.list
+https://docs.slack.dev/reference/methods/pins.list
def pins_remove(self, *, channel: str, timestamp: str | None = None, **kwargs) ‑> SlackResponse
@@ -12655,13 +12737,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Un-pins an item from a channel.
- https://api.slack.com/methods/pins.remove
+ https://docs.slack.dev/reference/methods/pins.remove
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
return self.api_call("pins.remove", params=kwargs)
Un-pins an item from a channel.
-https://api.slack.com/methods/pins.remove
+https://docs.slack.dev/reference/methods/pins.remove
def reactions_add(self, *, channel: str, name: str, timestamp: str, **kwargs) ‑> SlackResponse
@@ -12680,13 +12762,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Adds a reaction to an item.
- https://api.slack.com/methods/reactions.add
+ https://docs.slack.dev/reference/methods/reactions.add
"""
kwargs.update({"channel": channel, "name": name, "timestamp": timestamp})
return self.api_call("reactions.add", params=kwargs)
Adds a reaction to an item.
-https://api.slack.com/methods/reactions.add
+https://docs.slack.dev/reference/methods/reactions.add
def reactions_get(self,
*,
channel: str | None = None,
file: str | None = None,
file_comment: str | None = None,
full: bool | None = None,
timestamp: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12707,7 +12789,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets reactions for an item.
- https://api.slack.com/methods/reactions.get
+ https://docs.slack.dev/reference/methods/reactions.get
"""
kwargs.update(
{
@@ -12721,7 +12803,7 @@ Methods
return self.api_call("reactions.get", http_verb="GET", params=kwargs)
Gets reactions for an item.
-https://api.slack.com/methods/reactions.get
+https://docs.slack.dev/reference/methods/reactions.get
def reactions_list(self,
*,
count: int | None = None,
cursor: str | None = None,
full: bool | None = None,
limit: int | None = None,
page: int | None = None,
team_id: str | None = None,
user: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12744,7 +12826,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists reactions made by a user.
- https://api.slack.com/methods/reactions.list
+ https://docs.slack.dev/reference/methods/reactions.list
"""
kwargs.update(
{
@@ -12760,7 +12842,7 @@ Methods
return self.api_call("reactions.list", http_verb="GET", params=kwargs)
Lists reactions made by a user.
-https://api.slack.com/methods/reactions.list
+https://docs.slack.dev/reference/methods/reactions.list
def reactions_remove(self,
*,
name: str,
channel: str | None = None,
file: str | None = None,
file_comment: str | None = None,
timestamp: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12781,7 +12863,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Removes a reaction from an item.
- https://api.slack.com/methods/reactions.remove
+ https://docs.slack.dev/reference/methods/reactions.remove
"""
kwargs.update(
{
@@ -12795,7 +12877,7 @@ Methods
return self.api_call("reactions.remove", params=kwargs)
Removes a reaction from an item.
-https://api.slack.com/methods/reactions.remove
+https://docs.slack.dev/reference/methods/reactions.remove
def reminders_add(self,
*,
text: str,
time: str,
team_id: str | None = None,
user: str | None = None,
recurrence: str | None = None,
**kwargs) ‑> SlackResponse
@@ -12816,7 +12898,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Creates a reminder.
- https://api.slack.com/methods/reminders.add
+ https://docs.slack.dev/reference/methods/reminders.add
"""
kwargs.update(
{
@@ -12830,7 +12912,7 @@ Methods
return self.api_call("reminders.add", params=kwargs)
Creates a reminder.
-https://api.slack.com/methods/reminders.add
+https://docs.slack.dev/reference/methods/reminders.add
def reminders_complete(self, *, reminder: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -12848,13 +12930,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Marks a reminder as complete.
- https://api.slack.com/methods/reminders.complete
+ https://docs.slack.dev/reference/methods/reminders.complete
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.complete", params=kwargs)
Marks a reminder as complete.
-https://api.slack.com/methods/reminders.complete
+https://docs.slack.dev/reference/methods/reminders.complete
def reminders_delete(self, *, reminder: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -12872,13 +12954,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Deletes a reminder.
- https://api.slack.com/methods/reminders.delete
+ https://docs.slack.dev/reference/methods/reminders.delete
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.delete", params=kwargs)
Deletes a reminder.
-https://api.slack.com/methods/reminders.delete
+https://docs.slack.dev/reference/methods/reminders.delete
def reminders_info(self, *, reminder: str, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -12896,13 +12978,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets information about a reminder.
- https://api.slack.com/methods/reminders.info
+ https://docs.slack.dev/reference/methods/reminders.info
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
return self.api_call("reminders.info", http_verb="GET", params=kwargs)
Gets information about a reminder.
-https://api.slack.com/methods/reminders.info
+https://docs.slack.dev/reference/methods/reminders.info
def reminders_list(self, *, team_id: str | None = None, **kwargs) ‑> SlackResponse
@@ -12919,13 +13001,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists all reminders created by or for a given user.
- https://api.slack.com/methods/reminders.list
+ https://docs.slack.dev/reference/methods/reminders.list
"""
kwargs.update({"team_id": team_id})
return self.api_call("reminders.list", http_verb="GET", params=kwargs)
Lists all reminders created by or for a given user.
-https://api.slack.com/methods/reminders.list
+https://docs.slack.dev/reference/methods/reminders.list
def rtm_connect(self,
*,
batch_presence_aware: bool | None = None,
presence_sub: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -12943,13 +13025,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
- https://api.slack.com/methods/rtm.connect
+ https://docs.slack.dev/reference/methods/rtm.connect
"""
kwargs.update({"batch_presence_aware": batch_presence_aware, "presence_sub": presence_sub})
return self.api_call("rtm.connect", http_verb="GET", params=kwargs)
Starts a Real Time Messaging session.
-https://api.slack.com/methods/rtm.connect
+https://docs.slack.dev/reference/methods/rtm.connect
def rtm_start(self,
*,
batch_presence_aware: bool | None = None,
include_locale: bool | None = None,
mpim_aware: bool | None = None,
no_latest: bool | None = None,
no_unreads: bool | None = None,
presence_sub: bool | None = None,
simple_latest: bool | None = None,
**kwargs) ‑> SlackResponse
@@ -12972,7 +13054,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
- https://api.slack.com/methods/rtm.start
+ https://docs.slack.dev/reference/methods/rtm.start
"""
kwargs.update(
{
@@ -12988,7 +13070,7 @@ Methods
return self.api_call("rtm.start", http_verb="GET", params=kwargs)
Starts a Real Time Messaging session.
-https://api.slack.com/methods/rtm.start
+https://docs.slack.dev/reference/methods/rtm.start
def search_all(self,
*,
query: str,
count: int | None = None,
highlight: bool | None = None,
page: int | None = None,
sort: str | None = None,
sort_dir: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13011,7 +13093,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Searches for messages and files matching a query.
- https://api.slack.com/methods/search.all
+ https://docs.slack.dev/reference/methods/search.all
"""
kwargs.update(
{
@@ -13027,7 +13109,7 @@ Methods
return self.api_call("search.all", http_verb="GET", params=kwargs)
Searches for messages and files matching a query.
-https://api.slack.com/methods/search.all
+https://docs.slack.dev/reference/methods/search.all
def search_files(self,
*,
query: str,
count: int | None = None,
highlight: bool | None = None,
page: int | None = None,
sort: str | None = None,
sort_dir: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13050,7 +13132,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Searches for files matching a query.
- https://api.slack.com/methods/search.files
+ https://docs.slack.dev/reference/methods/search.files
"""
kwargs.update(
{
@@ -13066,7 +13148,7 @@ Methods
return self.api_call("search.files", http_verb="GET", params=kwargs)
Searches for files matching a query.
-https://api.slack.com/methods/search.files
+https://docs.slack.dev/reference/methods/search.files
def search_messages(self,
*,
query: str,
count: int | None = None,
cursor: str | None = None,
highlight: bool | None = None,
page: int | None = None,
sort: str | None = None,
sort_dir: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13090,7 +13172,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Searches for messages matching a query.
- https://api.slack.com/methods/search.messages
+ https://docs.slack.dev/reference/methods/search.messages
"""
kwargs.update(
{
@@ -13107,7 +13189,7 @@ Methods
return self.api_call("search.messages", http_verb="GET", params=kwargs)
Searches for messages matching a query.
-https://api.slack.com/methods/search.messages
+https://docs.slack.dev/reference/methods/search.messages
def stars_add(self,
*,
channel: str | None = None,
file: str | None = None,
file_comment: str | None = None,
timestamp: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13127,7 +13209,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Adds a star to an item.
- https://api.slack.com/methods/stars.add
+ https://docs.slack.dev/reference/methods/stars.add
"""
kwargs.update(
{
@@ -13140,7 +13222,7 @@ Methods
return self.api_call("stars.add", params=kwargs)
Adds a star to an item.
-https://api.slack.com/methods/stars.add
+https://docs.slack.dev/reference/methods/stars.add
def stars_list(self,
*,
count: int | None = None,
cursor: str | None = None,
limit: int | None = None,
page: int | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13161,7 +13243,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists stars for a user.
- https://api.slack.com/methods/stars.list
+ https://docs.slack.dev/reference/methods/stars.list
"""
kwargs.update(
{
@@ -13175,7 +13257,7 @@ Methods
return self.api_call("stars.list", http_verb="GET", params=kwargs)
Lists stars for a user.
-https://api.slack.com/methods/stars.list
+https://docs.slack.dev/reference/methods/stars.list
def stars_remove(self,
*,
channel: str | None = None,
file: str | None = None,
file_comment: str | None = None,
timestamp: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13195,7 +13277,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Removes a star from an item.
- https://api.slack.com/methods/stars.remove
+ https://docs.slack.dev/reference/methods/stars.remove
"""
kwargs.update(
{
@@ -13208,7 +13290,7 @@ Methods
return self.api_call("stars.remove", params=kwargs)
Removes a star from an item.
-https://api.slack.com/methods/stars.remove
+https://docs.slack.dev/reference/methods/stars.remove
def team_accessLogs(self,
*,
before: str | int | None = None,
count: str | int | None = None,
page: str | int | None = None,
team_id: str | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -13230,7 +13312,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets the access logs for the current team.
- https://api.slack.com/methods/team.accessLogs
+ https://docs.slack.dev/reference/methods/team.accessLogs
"""
kwargs.update(
{
@@ -13245,7 +13327,7 @@ Methods
return self.api_call("team.accessLogs", http_verb="GET", params=kwargs)
Gets the access logs for the current team.
-https://api.slack.com/methods/team.accessLogs
+https://docs.slack.dev/reference/methods/team.accessLogs
def team_billableInfo(self, *, team_id: str | None = None, user: str | None = None, **kwargs) ‑> SlackResponse
@@ -13263,13 +13345,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets billable users information for the current team.
- https://api.slack.com/methods/team.billableInfo
+ https://docs.slack.dev/reference/methods/team.billableInfo
"""
kwargs.update({"team_id": team_id, "user": user})
return self.api_call("team.billableInfo", http_verb="GET", params=kwargs)
Gets billable users information for the current team.
-https://api.slack.com/methods/team.billableInfo
+https://docs.slack.dev/reference/methods/team.billableInfo
def team_billing_info(self, **kwargs) ‑> SlackResponse
@@ -13284,12 +13366,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Reads a workspace's billing plan information.
- https://api.slack.com/methods/team.billing.info
+ https://docs.slack.dev/reference/methods/team.billing.info
"""
return self.api_call("team.billing.info", params=kwargs)
Reads a workspace's billing plan information.
-https://api.slack.com/methods/team.billing.info
+https://docs.slack.dev/reference/methods/team.billing.info
def team_externalTeams_disconnect(self, *, target_team: str, **kwargs) ‑> SlackResponse
@@ -13306,7 +13388,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Disconnects an external organization.
- https://api.slack.com/methods/team.externalTeams.disconnect
+ https://docs.slack.dev/reference/methods/team.externalTeams.disconnect
"""
kwargs.update(
{
@@ -13316,7 +13398,7 @@ Methods
return self.api_call("team.externalTeams.disconnect", params=kwargs)
Disconnects an external organization.
-https://api.slack.com/methods/team.externalTeams.disconnect
+https://docs.slack.dev/reference/methods/team.externalTeams.disconnect
def team_externalTeams_list(self,
*,
connection_status_filter: str | None = None,
slack_connect_pref_filter: Sequence[str] | None = None,
sort_direction: str | None = None,
sort_field: str | None = None,
workspace_filter: Sequence[str] | None = None,
cursor: str | None = None,
limit: int | None = None,
**kwargs) ‑> SlackResponse
@@ -13339,7 +13421,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Returns a list of all the external teams connected and details about the connection.
- https://api.slack.com/methods/team.externalTeams.list
+ https://docs.slack.dev/reference/methods/team.externalTeams.list
"""
kwargs.update(
{
@@ -13363,7 +13445,7 @@ Methods
return self.api_call("team.externalTeams.list", http_verb="GET", params=kwargs)
Returns a list of all the external teams connected and details about the connection.
-https://api.slack.com/methods/team.externalTeams.list
+https://docs.slack.dev/reference/methods/team.externalTeams.list
def team_info(self, *, team: str | None = None, domain: str | None = None, **kwargs) ‑> SlackResponse
@@ -13381,13 +13463,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets information about the current team.
- https://api.slack.com/methods/team.info
+ https://docs.slack.dev/reference/methods/team.info
"""
kwargs.update({"team": team, "domain": domain})
return self.api_call("team.info", http_verb="GET", params=kwargs)
Gets information about the current team.
-https://api.slack.com/methods/team.info
+https://docs.slack.dev/reference/methods/team.info
def team_integrationLogs(self,
*,
app_id: str | None = None,
change_type: str | None = None,
count: str | int | None = None,
page: str | int | None = None,
service_id: str | None = None,
team_id: str | None = None,
user: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13410,7 +13492,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets the integration logs for the current team.
- https://api.slack.com/methods/team.integrationLogs
+ https://docs.slack.dev/reference/methods/team.integrationLogs
"""
kwargs.update(
{
@@ -13426,7 +13508,7 @@ Methods
return self.api_call("team.integrationLogs", http_verb="GET", params=kwargs)
Gets the integration logs for the current team.
-https://api.slack.com/methods/team.integrationLogs
+https://docs.slack.dev/reference/methods/team.integrationLogs
def team_preferences_list(self, **kwargs) ‑> SlackResponse
@@ -13441,12 +13523,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve a list of a workspace's team preferences.
- https://api.slack.com/methods/team.preferences.list
+ https://docs.slack.dev/reference/methods/team.preferences.list
"""
return self.api_call("team.preferences.list", params=kwargs)
Retrieve a list of a workspace's team preferences.
-https://api.slack.com/methods/team.preferences.list
+https://docs.slack.dev/reference/methods/team.preferences.list
def team_profile_get(self, *, visibility: str | None = None, **kwargs) ‑> SlackResponse
@@ -13463,13 +13545,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieve a team's profile.
- https://api.slack.com/methods/team.profile.get
+ https://docs.slack.dev/reference/methods/team.profile.get
"""
kwargs.update({"visibility": visibility})
return self.api_call("team.profile.get", http_verb="GET", params=kwargs)
Retrieve a team's profile.
-https://api.slack.com/methods/team.profile.get
+https://docs.slack.dev/reference/methods/team.profile.get
def tooling_tokens_rotate(self, *, refresh_token: str, **kwargs) ‑> SlackResponse
@@ -13486,13 +13568,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Exchanges a refresh token for a new app configuration token
- https://api.slack.com/methods/tooling.tokens.rotate
+ https://docs.slack.dev/reference/methods/tooling.tokens.rotate
"""
kwargs.update({"refresh_token": refresh_token})
return self.api_call("tooling.tokens.rotate", params=kwargs)
Exchanges a refresh token for a new app configuration token
-https://api.slack.com/methods/tooling.tokens.rotate
+https://docs.slack.dev/reference/methods/tooling.tokens.rotate
def usergroups_create(self,
*,
name: str,
channels: str | Sequence[str] | None = None,
description: str | None = None,
handle: str | None = None,
include_count: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13514,7 +13596,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Create a User Group
- https://api.slack.com/methods/usergroups.create
+ https://docs.slack.dev/reference/methods/usergroups.create
"""
kwargs.update(
{
@@ -13532,7 +13614,7 @@ Methods
return self.api_call("usergroups.create", params=kwargs)
Create a User Group
-https://api.slack.com/methods/usergroups.create
+https://docs.slack.dev/reference/methods/usergroups.create
def usergroups_disable(self,
*,
usergroup: str,
include_count: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13551,13 +13633,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Disable an existing User Group
- https://api.slack.com/methods/usergroups.disable
+ https://docs.slack.dev/reference/methods/usergroups.disable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
return self.api_call("usergroups.disable", params=kwargs)
Disable an existing User Group
-https://api.slack.com/methods/usergroups.disable
+https://docs.slack.dev/reference/methods/usergroups.disable
def usergroups_enable(self,
*,
usergroup: str,
include_count: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13576,13 +13658,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Enable a User Group
- https://api.slack.com/methods/usergroups.enable
+ https://docs.slack.dev/reference/methods/usergroups.enable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
return self.api_call("usergroups.enable", params=kwargs)
Enable a User Group
-https://api.slack.com/methods/usergroups.enable
+https://docs.slack.dev/reference/methods/usergroups.enable
def usergroups_list(self,
*,
include_count: bool | None = None,
include_disabled: bool | None = None,
include_users: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13602,7 +13684,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all User Groups for a team
- https://api.slack.com/methods/usergroups.list
+ https://docs.slack.dev/reference/methods/usergroups.list
"""
kwargs.update(
{
@@ -13615,7 +13697,7 @@ Methods
return self.api_call("usergroups.list", http_verb="GET", params=kwargs)
List all User Groups for a team
-https://api.slack.com/methods/usergroups.list
+https://docs.slack.dev/reference/methods/usergroups.list
def usergroups_update(self,
*,
usergroup: str,
channels: str | Sequence[str] | None = None,
description: str | None = None,
handle: str | None = None,
include_count: bool | None = None,
name: str | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13638,7 +13720,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update an existing User Group
- https://api.slack.com/methods/usergroups.update
+ https://docs.slack.dev/reference/methods/usergroups.update
"""
kwargs.update(
{
@@ -13657,7 +13739,7 @@ Methods
return self.api_call("usergroups.update", params=kwargs)
Update an existing User Group
-https://api.slack.com/methods/usergroups.update
+https://docs.slack.dev/reference/methods/usergroups.update
def usergroups_users_list(self,
*,
usergroup: str,
include_disabled: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13676,7 +13758,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List all users in a User Group
- https://api.slack.com/methods/usergroups.users.list
+ https://docs.slack.dev/reference/methods/usergroups.users.list
"""
kwargs.update(
{
@@ -13688,7 +13770,7 @@ Methods
return self.api_call("usergroups.users.list", http_verb="GET", params=kwargs)
List all users in a User Group
-https://api.slack.com/methods/usergroups.users.list
+https://docs.slack.dev/reference/methods/usergroups.users.list
def usergroups_users_update(self,
*,
usergroup: str,
users: str | Sequence[str],
include_count: bool | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13708,7 +13790,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update the list of users for a User Group
- https://api.slack.com/methods/usergroups.users.update
+ https://docs.slack.dev/reference/methods/usergroups.users.update
"""
kwargs.update(
{
@@ -13724,7 +13806,7 @@ Methods
return self.api_call("usergroups.users.update", params=kwargs)
Update the list of users for a User Group
-https://api.slack.com/methods/usergroups.users.update
+https://docs.slack.dev/reference/methods/usergroups.users.update
def users_conversations(self,
*,
cursor: str | None = None,
exclude_archived: bool | None = None,
limit: int | None = None,
team_id: str | None = None,
types: str | Sequence[str] | None = None,
user: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13746,7 +13828,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""List conversations the calling user may access.
- https://api.slack.com/methods/users.conversations
+ https://docs.slack.dev/reference/methods/users.conversations
"""
kwargs.update(
{
@@ -13764,7 +13846,7 @@ Methods
return self.api_call("users.conversations", http_verb="GET", params=kwargs)
List conversations the calling user may access.
-https://api.slack.com/methods/users.conversations
+https://docs.slack.dev/reference/methods/users.conversations
def users_deletePhoto(self, **kwargs) ‑> SlackResponse
@@ -13779,12 +13861,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Delete the user profile photo
- https://api.slack.com/methods/users.deletePhoto
+ https://docs.slack.dev/reference/methods/users.deletePhoto
"""
return self.api_call("users.deletePhoto", http_verb="GET", params=kwargs)
Delete the user profile photo
-https://api.slack.com/methods/users.deletePhoto
+https://docs.slack.dev/reference/methods/users.deletePhoto
def users_discoverableContacts_lookup(self, email: str, **kwargs) ‑> SlackResponse
@@ -13800,13 +13882,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lookup an email address to see if someone is on Slack
- https://api.slack.com/methods/users.discoverableContacts.lookup
+ https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup
"""
kwargs.update({"email": email})
return self.api_call("users.discoverableContacts.lookup", params=kwargs)
Lookup an email address to see if someone is on Slack
-https://api.slack.com/methods/users.discoverableContacts.lookup
+https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup
def users_getPresence(self, *, user: str, **kwargs) ‑> SlackResponse
@@ -13823,13 +13905,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets user presence information.
- https://api.slack.com/methods/users.getPresence
+ https://docs.slack.dev/reference/methods/users.getPresence
"""
kwargs.update({"user": user})
return self.api_call("users.getPresence", http_verb="GET", params=kwargs)
Gets user presence information.
-https://api.slack.com/methods/users.getPresence
+https://docs.slack.dev/reference/methods/users.getPresence
def users_identity(self, **kwargs) ‑> SlackResponse
@@ -13844,12 +13926,12 @@ Methods
**kwargs,
) -> SlackResponse:
"""Get a user's identity.
- https://api.slack.com/methods/users.identity
+ https://docs.slack.dev/reference/methods/users.identity
"""
return self.api_call("users.identity", http_verb="GET", params=kwargs)
Get a user's identity.
-https://api.slack.com/methods/users.identity
+https://docs.slack.dev/reference/methods/users.identity
def users_info(self, *, user: str, include_locale: bool | None = None, **kwargs) ‑> SlackResponse
@@ -13867,13 +13949,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Gets information about a user.
- https://api.slack.com/methods/users.info
+ https://docs.slack.dev/reference/methods/users.info
"""
kwargs.update({"user": user, "include_locale": include_locale})
return self.api_call("users.info", http_verb="GET", params=kwargs)
Gets information about a user.
-https://api.slack.com/methods/users.info
+https://docs.slack.dev/reference/methods/users.info
def users_list(self,
*,
cursor: str | None = None,
include_locale: bool | None = None,
limit: int | None = None,
team_id: str | None = None,
**kwargs) ‑> SlackResponse
@@ -13893,7 +13975,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Lists all users in a Slack team.
- https://api.slack.com/methods/users.list
+ https://docs.slack.dev/reference/methods/users.list
"""
kwargs.update(
{
@@ -13906,7 +13988,7 @@ Methods
return self.api_call("users.list", http_verb="GET", params=kwargs)
Lists all users in a Slack team.
-https://api.slack.com/methods/users.list
+https://docs.slack.dev/reference/methods/users.list
def users_lookupByEmail(self, *, email: str, **kwargs) ‑> SlackResponse
@@ -13923,13 +14005,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Find a user with an email address.
- https://api.slack.com/methods/users.lookupByEmail
+ https://docs.slack.dev/reference/methods/users.lookupByEmail
"""
kwargs.update({"email": email})
return self.api_call("users.lookupByEmail", http_verb="GET", params=kwargs)
Find a user with an email address.
-https://api.slack.com/methods/users.lookupByEmail
+https://docs.slack.dev/reference/methods/users.lookupByEmail
def users_profile_get(self, *, user: str | None = None, include_labels: bool | None = None, **kwargs) ‑> SlackResponse
@@ -13947,13 +14029,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Retrieves a user's profile information.
- https://api.slack.com/methods/users.profile.get
+ https://docs.slack.dev/reference/methods/users.profile.get
"""
kwargs.update({"user": user, "include_labels": include_labels})
return self.api_call("users.profile.get", http_verb="GET", params=kwargs)
Retrieves a user's profile information.
-https://api.slack.com/methods/users.profile.get
+https://docs.slack.dev/reference/methods/users.profile.get
def users_profile_set(self,
*,
name: str | None = None,
value: str | None = None,
user: str | None = None,
profile: Dict | None = None,
**kwargs) ‑> SlackResponse
@@ -13973,7 +14055,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the profile information for a user.
- https://api.slack.com/methods/users.profile.set
+ https://docs.slack.dev/reference/methods/users.profile.set
"""
kwargs.update(
{
@@ -13988,7 +14070,7 @@ Methods
return self.api_call("users.profile.set", json=kwargs)
Set the profile information for a user.
-https://api.slack.com/methods/users.profile.set
+https://docs.slack.dev/reference/methods/users.profile.set
def users_setPhoto(self,
*,
image: str | io.IOBase,
crop_w: str | int | None = None,
crop_x: str | int | None = None,
crop_y: str | int | None = None,
**kwargs) ‑> SlackResponse
@@ -14008,13 +14090,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Set the user profile photo
- https://api.slack.com/methods/users.setPhoto
+ https://docs.slack.dev/reference/methods/users.setPhoto
"""
kwargs.update({"crop_w": crop_w, "crop_x": crop_x, "crop_y": crop_y})
return self.api_call("users.setPhoto", files={"image": image}, data=kwargs)
Set the user profile photo
-https://api.slack.com/methods/users.setPhoto
+https://docs.slack.dev/reference/methods/users.setPhoto
def users_setPresence(self, *, presence: str, **kwargs) ‑> SlackResponse
@@ -14031,13 +14113,13 @@ Methods
**kwargs,
) -> SlackResponse:
"""Manually sets user presence.
- https://api.slack.com/methods/users.setPresence
+ https://docs.slack.dev/reference/methods/users.setPresence
"""
kwargs.update({"presence": presence})
return self.api_call("users.setPresence", params=kwargs)
Manually sets user presence.
-https://api.slack.com/methods/users.setPresence
+https://docs.slack.dev/reference/methods/users.setPresence
def views_open(self,
*,
trigger_id: str | None = None,
interactivity_pointer: str | None = None,
view: dict | View,
**kwargs) ‑> SlackResponse
@@ -14056,8 +14138,8 @@ Methods
**kwargs,
) -> SlackResponse:
"""Open a view for a user.
- https://api.slack.com/methods/views.open
- See https://api.slack.com/surfaces/modals for details.
+ https://docs.slack.dev/reference/methods/views.open
+ See https://docs.slack.dev/surfaces/modals/ for details.
"""
kwargs.update({"trigger_id": trigger_id, "interactivity_pointer": interactivity_pointer})
if isinstance(view, View):
@@ -14069,8 +14151,8 @@ Methods
return self.api_call("views.open", json=kwargs)
Open a view for a user.
-https://api.slack.com/methods/views.open
-See https://api.slack.com/surfaces/modals for details.
+https://docs.slack.dev/reference/methods/views.open
+See https://docs.slack.dev/surfaces/modals/ for details.
def views_publish(self,
*,
user_id: str,
view: dict | View,
hash: str | None = None,
**kwargs) ‑> SlackResponse
@@ -14090,8 +14172,8 @@ Methods
) -> SlackResponse:
"""Publish a static view for a User.
Create or update the view that comprises an
- app's Home tab (https://api.slack.com/surfaces/tabs)
- https://api.slack.com/methods/views.publish
+ app's Home tab (https://docs.slack.dev/surfaces/app-home/)
+ https://docs.slack.dev/reference/methods/views.publish
"""
kwargs.update({"user_id": user_id, "hash": hash})
if isinstance(view, View):
@@ -14104,8 +14186,8 @@ Methods
Publish a static view for a User.
Create or update the view that comprises an
-app's Home tab (https://api.slack.com/surfaces/tabs)
-https://api.slack.com/methods/views.publish
+app's Home tab (https://docs.slack.dev/surfaces/app-home/)
+https://docs.slack.dev/reference/methods/views.publish
def views_push(self,
*,
trigger_id: str | None = None,
interactivity_pointer: str | None = None,
view: dict | View,
**kwargs) ‑> SlackResponse
@@ -14127,9 +14209,9 @@ Methods
Push a new view onto the existing view stack by passing a view
payload and a valid trigger_id generated from an interaction
within the existing modal.
- Read the modals documentation (https://api.slack.com/surfaces/modals)
+ Read the modals documentation (https://docs.slack.dev/surfaces/modals/)
to learn more about the lifecycle and intricacies of views.
- https://api.slack.com/methods/views.push
+ https://docs.slack.dev/reference/methods/views.push
"""
kwargs.update({"trigger_id": trigger_id, "interactivity_pointer": interactivity_pointer})
if isinstance(view, View):
@@ -14144,9 +14226,9 @@ Methods
Push a new view onto the existing view stack by passing a view
payload and a valid trigger_id generated from an interaction
within the existing modal.
-Read the modals documentation (https://api.slack.com/surfaces/modals)
+Read the modals documentation (https://docs.slack.dev/surfaces/modals/)
to learn more about the lifecycle and intricacies of views.
-https://api.slack.com/methods/views.push
+https://docs.slack.dev/reference/methods/views.push
def views_update(self,
*,
view: dict | View,
external_id: str | None = None,
view_id: str | None = None,
hash: str | None = None,
**kwargs) ‑> SlackResponse
@@ -14168,9 +14250,9 @@ Methods
"""Update an existing view.
Update a view by passing a new view definition along with the
view_id returned in views.open or the external_id.
- See the modals documentation (https://api.slack.com/surfaces/modals#updating_views)
+ See the modals documentation (https://docs.slack.dev/surfaces/modals/#updating_views)
to learn more about updating views and avoiding race conditions with the hash argument.
- https://api.slack.com/methods/views.update
+ https://docs.slack.dev/reference/methods/views.update
"""
if isinstance(view, View):
kwargs.update({"view": view.to_dict()})
@@ -14190,9 +14272,119 @@ Methods
Update an existing view.
Update a view by passing a new view definition along with the
view_id returned in views.open or the external_id.
-See the modals documentation (https://api.slack.com/surfaces/modals#updating_views)
+See the modals documentation (https://docs.slack.dev/surfaces/modals/#updating_views)
to learn more about updating views and avoiding race conditions with the hash argument.
-https://api.slack.com/methods/views.update
+https://docs.slack.dev/reference/methods/views.update
+
+
+def workflows_featured_add(self, *, channel_id: str, trigger_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
+
+
+
+Expand source code
+
+def workflows_featured_add(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+) -> SlackResponse:
+ """Add featured workflows to a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.add
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.add", params=kwargs)
+
+Add featured workflows to a channel.
+https://docs.slack.dev/reference/methods/workflows.featured.add
+
+
+def workflows_featured_list(self, *, channel_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
+
+
+
+Expand source code
+
+def workflows_featured_list(
+ self,
+ *,
+ channel_ids: Union[str, Sequence[str]],
+ **kwargs,
+) -> SlackResponse:
+ """List the featured workflows for specified channels.
+ https://docs.slack.dev/reference/methods/workflows.featured.list
+ """
+ if isinstance(channel_ids, (list, tuple)):
+ kwargs.update({"channel_ids": ",".join(channel_ids)})
+ else:
+ kwargs.update({"channel_ids": channel_ids})
+ return self.api_call("workflows.featured.list", params=kwargs)
+
+List the featured workflows for specified channels.
+https://docs.slack.dev/reference/methods/workflows.featured.list
+
+
+def workflows_featured_remove(self, *, channel_id: str, trigger_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
+
+
+
+Expand source code
+
+def workflows_featured_remove(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+) -> SlackResponse:
+ """Remove featured workflows from a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.remove
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.remove", params=kwargs)
+
+Remove featured workflows from a channel.
+https://docs.slack.dev/reference/methods/workflows.featured.remove
+
+
+def workflows_featured_set(self, *, channel_id: str, trigger_ids: str | Sequence[str], **kwargs) ‑> SlackResponse
+
+
+
+Expand source code
+
+def workflows_featured_set(
+ self,
+ *,
+ channel_id: str,
+ trigger_ids: Union[str, Sequence[str]],
+ **kwargs,
+) -> SlackResponse:
+ """Set featured workflows for a channel.
+ https://docs.slack.dev/reference/methods/workflows.featured.set
+ """
+ kwargs.update({"channel_id": channel_id})
+ if isinstance(trigger_ids, (list, tuple)):
+ kwargs.update({"trigger_ids": ",".join(trigger_ids)})
+ else:
+ kwargs.update({"trigger_ids": trigger_ids})
+ return self.api_call("workflows.featured.set", params=kwargs)
+
+Set featured workflows for a channel.
+https://docs.slack.dev/reference/methods/workflows.featured.set
def workflows_stepCompleted(self, *, workflow_step_execute_id: str, outputs: dict | None = None, **kwargs) ‑> SlackResponse
@@ -14210,7 +14402,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Indicate a successful outcome of a workflow step's execution.
- https://api.slack.com/methods/workflows.stepCompleted
+ https://docs.slack.dev/reference/methods/workflows.stepCompleted
"""
kwargs.update({"workflow_step_execute_id": workflow_step_execute_id})
if outputs is not None:
@@ -14220,7 +14412,7 @@ Methods
return self.api_call("workflows.stepCompleted", json=kwargs)
Indicate a successful outcome of a workflow step's execution.
-https://api.slack.com/methods/workflows.stepCompleted
+https://docs.slack.dev/reference/methods/workflows.stepCompleted
def workflows_stepFailed(self, *, workflow_step_execute_id: str, error: Dict[str, str], **kwargs) ‑> SlackResponse
@@ -14238,7 +14430,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Indicate an unsuccessful outcome of a workflow step's execution.
- https://api.slack.com/methods/workflows.stepFailed
+ https://docs.slack.dev/reference/methods/workflows.stepFailed
"""
kwargs.update(
{
@@ -14251,7 +14443,7 @@ Methods
return self.api_call("workflows.stepFailed", json=kwargs)
Indicate an unsuccessful outcome of a workflow step's execution.
-https://api.slack.com/methods/workflows.stepFailed
+https://docs.slack.dev/reference/methods/workflows.stepFailed
def workflows_updateStep(self,
*,
workflow_step_edit_id: str,
inputs: Dict[str, Any] | None = None,
outputs: List[Dict[str, str]] | None = None,
**kwargs) ‑> SlackResponse
@@ -14270,7 +14462,7 @@ Methods
**kwargs,
) -> SlackResponse:
"""Update the configuration for a workflow extension step.
- https://api.slack.com/methods/workflows.updateStep
+ https://docs.slack.dev/reference/methods/workflows.updateStep
"""
kwargs.update({"workflow_step_edit_id": workflow_step_edit_id})
if inputs is not None:
@@ -14282,7 +14474,7 @@ Methods
return self.api_call("workflows.updateStep", json=kwargs)
Update the configuration for a workflow extension step.
-https://api.slack.com/methods/workflows.updateStep
+https://docs.slack.dev/reference/methods/workflows.updateStep
Inherited members
@@ -14335,7 +14527,7 @@ Inherited members
):
"""API client for Incoming Webhooks and `response_url`
- https://api.slack.com/messaging/webhooks
+ https://docs.slack.dev/messaging/sending-messages-using-incoming-webhooks/
Args:
url: Complete URL to send data (e.g., `https://hooks.slack.com/XXX`)
@@ -14554,19 +14746,19 @@ Inherited members
http_resp = opener.open(req, timeout=self.timeout)
else:
http_resp = urlopen(req, context=self.ssl, timeout=self.timeout)
- charset: str = http_resp.headers.get_content_charset() or "utf-8" # type: ignore[union-attr]
- response_body: str = http_resp.read().decode(charset) # type: ignore[union-attr]
+ charset: str = http_resp.headers.get_content_charset() or "utf-8"
+ response_body: str = http_resp.read().decode(charset)
resp = WebhookResponse(
url=url,
- status_code=http_resp.status, # type: ignore[union-attr]
+ status_code=http_resp.status,
body=response_body,
- headers=http_resp.headers, # type: ignore[arg-type, union-attr]
+ headers=http_resp.headers, # type: ignore[arg-type]
)
_debug_log_response(self.logger, resp)
return resp
API client for Incoming Webhooks and response_url
-https://api.slack.com/messaging/webhooks
+https://docs.slack.dev/messaging/sending-messages-using-incoming-webhooks/
Args
urlWebClientviews_publish
views_pushviews_updateworkflows_featured_addworkflows_featured_listworkflows_featured_removeworkflows_featured_setworkflows_stepCompletedworkflows_stepFailedworkflows_updateStepClasses
return json
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Ancestors
- Action
@@ -161,8 +161,8 @@ Inherited members
class Action(JsonObject):
"""Action in attachments
- https://api.slack.com/messaging/composing/layouts#attachments
- https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+ https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
"""
attributes = {"name", "text", "url"}
@@ -190,8 +190,8 @@ Inherited members
return json
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Ancestors
- JsonObject
@@ -265,7 +265,7 @@ Inherited members
):
"""Simple button for use inside attachments
- https://api.slack.com/legacy/message-buttons
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons/
Args:
name: Name this specific action. The name will be returned to your
@@ -303,10 +303,10 @@ Inherited members
return json
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Simple button for use inside attachments
-https://api.slack.com/legacy/message-buttons
+https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons/
Args
nameInherited members
Automatically populate the selector with a list of public channels in the
workspace.
- https://api.slack.com/legacy/message-menus#let_users_choose_one_of_their_workspace_s_channels
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_channels
Args:
name: Name this specific action. The name will be returned to your
@@ -430,11 +430,11 @@ Inherited members
super().__init__(name=name, text=text, selected_option=selected_channel)
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Automatically populate the selector with a list of public channels in the
workspace.
-https://api.slack.com/legacy/message-menus#let_users_choose_one_of_their_workspace_s_channels
+https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_channels
Args
nameInherited members
Automatically populate the selector with a list of conversations they have in
the workspace.
- https://api.slack.com/legacy/message-menus#let_users_choose_one_of_their_conversations
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_conversations
Args:
name: Name this specific action. The name will be returned to your
@@ -506,11 +506,11 @@ Inherited members
super().__init__(name=name, text=text, selected_option=selected_conversation)
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Automatically populate the selector with a list of conversations they have in
the workspace.
-https://api.slack.com/legacy/message-menus#let_users_choose_one_of_their_conversations
+https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_conversations
Args
nameInherited members
"""
Populate a message select menu from your own application dynamically.
- https://api.slack.com/legacy/message-menus#populate_message_menus_dynamically
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_dynamic
Args:
name: Name this specific action. The name will be returned to your
@@ -595,10 +595,10 @@ Inherited members
self.min_query_length = min_query_length
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Populate a message select menu from your own application dynamically.
-https://api.slack.com/legacy/message-menus#populate_message_menus_dynamically
+https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_dynamic
Args
nameInherited members
def __init__(self, *, text: str, url: str):
"""A simple interactive button that just opens a URL
- https://api.slack.com/messaging/composing/layouts#attachments
+ https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
Args:
text: text to display on the button, eg 'Click Me!"
@@ -678,10 +678,10 @@ Inherited members
super().__init__(text=text, url=url, subtype="button")
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
A simple interactive button that just opens a URL
-https://api.slack.com/messaging/composing/layouts#attachments
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
Args
textInherited members
def __init__(self, name: str, text: str, selected_user: Optional[Option] = None):
"""Automatically populate the selector with a list of users in the workspace.
- https://api.slack.com/legacy/message-menus#allow_users_to_select_from_a_list_of_members
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_team_members
Args:
name: Name this specific action. The name will be returned to your
@@ -736,10 +736,10 @@ Inherited members
super().__init__(name=name, text=text, selected_option=selected_user)
Action in attachments
-https://api.slack.com/messaging/composing/layouts#attachments
-https://api.slack.com/legacy/interactive-message-field-guide#message_action_fields
+https://docs.slack.dev/messaging/formatting-message-text/#rich-layouts
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#message_action_fields
Automatically populate the selector with a list of users in the workspace.
-https://api.slack.com/legacy/message-menus#allow_users_to_select_from_a_list_of_members
+https://docs.slack.dev/legacy/legacy-messaging/legacy-adding-menus-to-messages/#menu_team_members
Args
nameInherited members
A supplemental object that will display after the rest of the message.
Considered legacy - recommended replacement is to use message blocks instead.
- https://api.slack.com/reference/messaging/attachments#fields
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args:
text: The main body text of the attachment. It can be formatted as
@@ -956,7 +956,7 @@ Inherited members
The base class for JSON serializable class objects
A supplemental object that will display after the rest of the message.
Considered legacy - recommended replacement is to use message blocks instead.
-https://api.slack.com/reference/messaging/attachments#fields
+https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args
textInherited members
A bridge between legacy attachments and Block Kit formatting - pass a list of
Block objects directly to this attachment.
- https://api.slack.com/reference/messaging/attachments#fields
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args:
blocks: a sequence of Block objects
@@ -1272,7 +1272,7 @@ Inherited members
The base class for JSON serializable class objects
A bridge between legacy attachments and Block Kit formatting - pass a list of
Block objects directly to this attachment.
-https://api.slack.com/reference/messaging/attachments#fields
+https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args
blocksInherited members
An Attachment, but designed to contain interactive Actions
Considered legacy - recommended replacement is to use message blocks instead.
- https://api.slack.com/legacy/interactive-message-field-guide#attachment_fields
- https://api.slack.com/reference/messaging/attachments#fields
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#attachment_fields
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args:
actions: A collection of Action objects to include in the attachment.
@@ -1481,8 +1481,8 @@ Inherited members
The base class for JSON serializable class objects
An Attachment, but designed to contain interactive Actions
Considered legacy - recommended replacement is to use message blocks instead.
-https://api.slack.com/legacy/interactive-message-field-guide#attachment_fields
-https://api.slack.com/reference/messaging/attachments#fields
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#attachment_fields
+https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments#fields
Args
actionsClasses
Expand source code
class ConfirmObject(JsonObject):
- attributes = {} # type: ignore[assignment] # no attributes because to_dict has unique implementations
+ attributes: Set[str] = set()
title_max_length = 100
text_max_length = 300
@@ -88,7 +88,7 @@ Classes
An object that defines a dialog that provides a confirmation step to any
interactive element. This dialog will ask the user to confirm their action by
offering a confirm and deny button.
- https://api.slack.com/reference/block-kit/composition-objects#confirm
+ https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object/
"""
self._title = TextObject.parse(title, default_type=PlainTextObject.type)
self._text = TextObject.parse(text, default_type=MarkdownTextObject.type)
@@ -156,7 +156,7 @@ Classes
An object that defines a dialog that provides a confirmation step to any
interactive element. This dialog will ask the user to confirm their action by
offering a confirm and deny button.
-https://api.slack.com/reference/block-kit/composition-objects#confirm
+https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object/
Ancestors
- JsonObject
@@ -164,7 +164,7 @@ Ancestors
Class variables
-var attributesvar attributes : Set[str]-
The type of the None singleton.
@@ -295,7 +295,7 @@ Inherited members
):
"""
Determines when a plain-text input element will return a block_actions interaction payload.
- https://api.slack.com/reference/block-kit/composition-objects#dispatch_action_config
+ https://docs.slack.dev/reference/block-kit/composition-objects/dispatch-action-configuration-object
"""
self._trigger_actions_on = trigger_actions_on or []
@@ -308,7 +308,7 @@ Inherited members
The base class for JSON serializable class objects
Determines when a plain-text input element will return a block_actions interaction payload.
-https://api.slack.com/reference/block-kit/composition-objects#dispatch_action_config
+https://docs.slack.dev/reference/block-kit/composition-objects/dispatch-action-configuration-object
Ancestors
- JsonObject
@@ -362,7 +362,7 @@ Inherited members
def __init__(self, *, text: str, verbatim: Optional[bool] = None):
"""A Markdown text object, meaning markdown characters will be parsed as
formatting information.
- https://api.slack.com/reference/block-kit/composition-objects#text
+ https://docs.slack.dev/reference/block-kit/composition-objects/text-object
Args:
text (required): The text for the block. This field accepts any of the standard text formatting markup
@@ -406,7 +406,7 @@ Inherited members
mrkdwn typed text object
A Markdown text object, meaning markdown characters will be parsed as
formatting information.
-https://api.slack.com/reference/block-kit/composition-objects#text
+https://docs.slack.dev/reference/block-kit/composition-objects/text-object
Args
text : requiredInherited members
different required formats in different situations
"""
- attributes = {} # type: ignore[assignment] # no attributes because to_dict has unique implementations
+ attributes: Set[str] = set()
logger = logging.getLogger(__name__)
label_max_length = 75
@@ -568,13 +568,13 @@ Inherited members
(StaticDialogSelectElement)
Blocks:
- https://api.slack.com/reference/block-kit/composition-objects#option
+ https://docs.slack.dev/reference/block-kit/composition-objects/option-object
Dialogs:
- https://api.slack.com/dialogs#select_elements
+ https://docs.slack.dev/legacy/legacy-dialogs/#select_elements
Legacy interactive attachments:
- https://api.slack.com/legacy/interactive-message-field-guide#option_fields
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#option_fields
Args:
label: A short, user-facing string to label this option to users.
@@ -693,11 +693,11 @@ Inherited members
SelectElement, OverflowMenuElement) or dialog element
(StaticDialogSelectElement)
Blocks:
-https://api.slack.com/reference/block-kit/composition-objects#option
+https://docs.slack.dev/reference/block-kit/composition-objects/option-object
Dialogs:
-https://api.slack.com/dialogs#select_elements
+https://docs.slack.dev/legacy/legacy-dialogs/#select_elements
Legacy interactive attachments:
-https://api.slack.com/legacy/interactive-message-field-guide#option_fields
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#option_fields
Args
labelAncestors
Class variables
-var attributesvar attributes : Set[str]-
The type of the None singleton.
@@ -828,7 +828,7 @@ Inherited members
different required formats in different situations
"""
- attributes = {} # type: ignore[assignment] # no attributes because to_dict has unique implementations
+ attributes: Set[str] = set()
label_max_length = 75
options_max_length = 100
logger = logging.getLogger(__name__)
@@ -845,13 +845,13 @@ Inherited members
UI) and a list of Option objects.
Blocks:
- https://api.slack.com/reference/block-kit/composition-objects#option-group
+ https://docs.slack.dev/reference/block-kit/composition-objects/option-group-object
Dialogs:
- https://api.slack.com/dialogs#select_elements
+ https://docs.slack.dev/legacy/legacy-dialogs/#select_elements
Legacy interactive attachments:
- https://api.slack.com/legacy/interactive-message-field-guide#option_groups_to_place_within_message_menu_actions
+ https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#option_groups
Args:
label: Text to display at the top of this group of options.
@@ -913,11 +913,11 @@ Inherited members
Create a group of Option objects - pass in a label (that will be part of the
UI) and a list of Option objects.
Blocks:
-https://api.slack.com/reference/block-kit/composition-objects#option-group
+https://docs.slack.dev/reference/block-kit/composition-objects/option-group-object
Dialogs:
-https://api.slack.com/dialogs#select_elements
+https://docs.slack.dev/legacy/legacy-dialogs/#select_elements
Legacy interactive attachments:
-https://api.slack.com/legacy/interactive-message-field-guide#option_groups_to_place_within_message_menu_actions
+https://docs.slack.dev/legacy/legacy-messaging/legacy-interactive-message-field-guide/#option_groups
Args
labelAncestors
Class variables
-var attributesvar attributes : Set[str]-
The type of the None singleton.
@@ -990,7 +990,7 @@ Inherited members
def __init__(self, *, text: str, emoji: Optional[bool] = None):
"""A plain text object, meaning markdown characters will not be parsed as
formatting information.
- https://api.slack.com/reference/block-kit/composition-objects#text
+ https://docs.slack.dev/reference/block-kit/composition-objects/text-object
Args:
text (required): The text for the block. This field accepts any of the standard text formatting markup
@@ -1013,7 +1013,7 @@ Inherited members
plain_text typed text object
A plain text object, meaning markdown characters will not be parsed as
formatting information.
-https://api.slack.com/reference/block-kit/composition-objects#text
+https://docs.slack.dev/reference/block-kit/composition-objects/text-object
Args
text : requiredInherited members
url: Optional[str] = None,
):
"""An object containing Slack file information to be used in an image block or image element.
- https://api.slack.com/reference/block-kit/composition-objects#slack_file
+ https://docs.slack.dev/reference/block-kit/composition-objects/slack-file-object
Args:
id: Slack ID of the file.
@@ -1134,7 +1134,7 @@ Inherited members
The base class for JSON serializable class objects
An object containing Slack file information to be used in an image block or image element.
-https://api.slack.com/reference/block-kit/composition-objects#slack_file
+https://docs.slack.dev/reference/block-kit/composition-objects/slack-file-object
Args
idClasses
class BlockElement(JsonObject, metaclass=ABCMeta):
"""Block Elements are things that exists inside of your Blocks.
- https://api.slack.com/reference/block-kit/block-elements
+ https://docs.slack.dev/reference/block-kit/block-elements/
"""
attributes = {"type"}
@@ -119,7 +119,7 @@ Classes
yield from subclass._get_sub_block_elements()
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- JsonObject
@@ -216,7 +216,7 @@ Inherited members
):
"""An interactive element that inserts a button. The button can be a trigger for
anything from opening a simple link to starting a complex workflow.
- https://api.slack.com/reference/block-kit/block-elements#button
+ https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args:
text (required): A text object that defines the button's text.
@@ -275,10 +275,10 @@ Inherited members
return self.accessibility_label is None or len(self.accessibility_label) <= self.text_max_length
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An interactive element that inserts a button. The button can be a trigger for
anything from opening a simple link to starting a complex workflow.
-https://api.slack.com/reference/block-kit/block-elements#button
+https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args
text : requiredInherited members
"""
This multi-select menu will populate its options with a list of public channels visible
to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#channel_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -417,10 +417,10 @@ Inherited members
self.max_selected_items = max_selected_items
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This multi-select menu will populate its options with a list of public channels visible
to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#channel_multi_select
Args
placeholder : requiredInherited members
"""
This select menu will populate its options with a list of public channels
visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#channel_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#channels_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -550,10 +550,10 @@ Inherited members
self.response_url_enabled = response_url_enabled
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of public channels
visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#channel_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#channels_select
Args
placeholder : requiredInherited members
**others: dict,
):
"""A checkbox group that allows a user to choose multiple items from a list of possible options.
- https://api.slack.com/reference/block-kit/block-elements#checkboxes
+ https://docs.slack.dev/reference/block-kit/block-elements/checkboxes-element/
Args:
action_id (required): An identifier for the action triggered when the checkbox group is changed.
@@ -676,9 +676,9 @@ Inherited members
self.initial_options = Option.parse_all(initial_options)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A checkbox group that allows a user to choose multiple items from a list of possible options.
-https://api.slack.com/reference/block-kit/block-elements#checkboxes
+https://docs.slack.dev/reference/block-kit/block-elements/checkboxes-element/
Args
action_id : requiredInherited members
):
"""Provides a way to filter the list of options in a conversations select menu
or conversations multi-select menu.
- https://api.slack.com/reference/block-kit/composition-objects#filter_conversations
+ https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object
Args:
include: Indicates which type of conversations should be included in the list.
@@ -795,7 +795,7 @@ Inherited members
The base class for JSON serializable class objects
Provides a way to filter the list of options in a conversations select menu
or conversations multi-select menu.
-https://api.slack.com/reference/block-kit/composition-objects#filter_conversations
+https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object
Args
includeInherited members
"""
This multi-select menu will populate its options with a list of public and private channels,
DMs, and MPIMs visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element/#conversation_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -921,10 +921,10 @@ Inherited members
self.filter = ConversationFilter.parse(filter) # type: ignore[arg-type]
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This multi-select menu will populate its options with a list of public and private channels,
DMs, and MPIMs visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element/#conversation_multi_select
Args
placeholder : requiredInherited members
"""
This select menu will populate its options with a list of public and private
channels, DMs, and MPIMs visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#conversation_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#conversations_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -1082,10 +1082,10 @@ Inherited members
self.filter = filter
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of public and private
channels, DMs, and MPIMs visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#conversation_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#conversations_select
Args
placeholder : requiredInherited members
"""
An element which lets users easily select a date from a calendar style UI.
Date picker elements can be used inside of SectionBlocks and ActionsBlocks.
- https://api.slack.com/reference/block-kit/block-elements#datepicker
+ https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element
Args:
action_id (required): An identifier for the action triggered when a menu option is selected.
@@ -1231,10 +1231,10 @@ Inherited members
)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An element which lets users easily select a date from a calendar style UI.
Date picker elements can be used inside of SectionBlocks and ActionsBlocks.
-https://api.slack.com/reference/block-kit/block-elements#datepicker
+https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element
Args
action_id : requiredInherited members
date picker will take the form of a dropdown calendar. Both options will have free-text
entry for precise choices. On mobile clients, the time picker and date
picker will use native UIs.
- https://api.slack.com/reference/block-kit/block-elements#datetimepicker
+ https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element/
Args:
action_id (required): An identifier for the action triggered when a time is selected. You can use this
@@ -1360,13 +1360,13 @@ Inherited members
return self.initial_date_time is None or (0 <= self.initial_date_time <= 9999999999)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An element that allows the selection of a time of day formatted as a UNIX timestamp.
On desktop clients, this time picker will take the form of a dropdown list and the
date picker will take the form of a dropdown calendar. Both options will have free-text
entry for precise choices. On mobile clients, the time picker and date
picker will use native UIs.
-https://api.slack.com/reference/block-kit/block-elements#datetimepicker
+https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element/
Args
action_id : requiredInherited members
**others: dict,
):
"""
- https://api.slack.com/reference/block-kit/block-elements#email
+ https://docs.slack.dev/reference/block-kit/block-elements/email-input-element
Args:
action_id (required): An identifier for the input value when the parent modal is submitted.
@@ -1488,8 +1488,8 @@ Inherited members
self.dispatch_action_config = dispatch_action_config
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
-https://api.slack.com/reference/block-kit/block-elements#email
+https://docs.slack.dev/reference/block-kit/block-elements/
+https://docs.slack.dev/reference/block-kit/block-elements/email-input-element
Args
action_id : requiredInherited members
"""
This select menu will load its options from an external data source, allowing
for a dynamic list of options.
- https://api.slack.com/reference/block-kit/block-elements#external_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -1626,10 +1626,10 @@ Inherited members
self.max_selected_items = max_selected_items
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will load its options from an external data source, allowing
for a dynamic list of options.
-https://api.slack.com/reference/block-kit/block-elements#external_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select
Args
placeholder : requiredInherited members
"""
This select menu will load its options from an external data source, allowing
for a dynamic list of options.
- https://api.slack.com/reference/block-kit/block-elements#external_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#external_select
Args:
action_id (required): An identifier for the action triggered when a menu option is selected.
@@ -1768,10 +1768,10 @@ Inherited members
self.initial_option = initial_option
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will load its options from an external data source, allowing
for a dynamic list of options.
-https://api.slack.com/reference/block-kit/block-elements#external_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#external_select
Args
action_id : requiredInherited members
**others: dict,
):
"""
- https://api.slack.com/reference/block-kit/block-elements#file_input
+ https://docs.slack.dev/reference/block-kit/block-elements/file-input-element
Args:
action_id (required): An identifier for the input value when the parent modal is submitted.
@@ -1896,8 +1896,8 @@ Inherited members
self.max_files = max_files
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
-https://api.slack.com/reference/block-kit/block-elements#file_input
+https://docs.slack.dev/reference/block-kit/block-elements/
+https://docs.slack.dev/reference/block-kit/block-elements/file-input-element
Args
action_id : requiredInherited members
"""An element to insert an image - this element can be used in section and
context blocks only. If you want a block with only an image in it,
you're looking for the image block.
- https://api.slack.com/reference/block-kit/block-elements#image
+ https://docs.slack.dev/reference/block-kit/block-elements/image-element
Args:
alt_text (required): A plain-text summary of the image. This should not contain any markup.
@@ -2014,11 +2014,11 @@ Inherited members
return len(self.alt_text) <= self.alt_text_max_length # type: ignore[arg-type]
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An element to insert an image - this element can be used in section and
context blocks only. If you want a block with only an image in it,
you're looking for the image block.
-https://api.slack.com/reference/block-kit/block-elements#image
+https://docs.slack.dev/reference/block-kit/block-elements/image-element
Args
alt_text : requiredInherited members
)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
InteractiveElement that is usable in input blocks
We generally recommend using the concrete subclasses for better supports of available properties.
Ancestors
@@ -2247,7 +2247,7 @@ Inherited members
return self.action_id is None or len(self.action_id) <= self.action_id_max_length
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An interactive block element.
We generally recommend using the concrete subclasses for better supports of available properties.
Ancestors
@@ -2319,7 +2319,7 @@ Inherited members
"""A simple button that simply opens a given URL. You will still receive an
interaction payload and will need to send an acknowledgement response.
This is a helper class that makes creating links simpler.
- https://api.slack.com/reference/block-kit/block-elements#button
+ https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args:
text (required): A text object that defines the button's text.
@@ -2351,11 +2351,11 @@ Inherited members
show_unknown_key_warning(self, others)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A simple button that simply opens a given URL. You will still receive an
interaction payload and will need to send an acknowledgement response.
This is a helper class that makes creating links simpler.
-https://api.slack.com/reference/block-kit/block-elements#button
+https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args
text : requiredInherited members
**others: dict,
):
"""
- https://api.slack.com/reference/block-kit/block-elements#number
+ https://docs.slack.dev/reference/block-kit/block-elements/number-input-element/
Args:
action_id (required): An identifier for the input value when the parent modal is submitted.
@@ -2478,8 +2478,8 @@ Inherited members
self.dispatch_action_config = dispatch_action_config
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
-https://api.slack.com/reference/block-kit/block-elements#number
+https://docs.slack.dev/reference/block-kit/block-elements/
+https://docs.slack.dev/reference/block-kit/block-elements/number-input-element/
Args
action_id : requiredInherited members
buttons. You can also specify simple URL links as overflow menu options,
instead of actions.
- https://api.slack.com/reference/block-kit/block-elements#overflow
+ https://docs.slack.dev/reference/block-kit/block-elements/overflow-menu-element
Args:
action_id (required): An identifier for the action triggered when a menu option is selected.
@@ -2618,7 +2618,7 @@ Inherited members
return self.options_min_length <= len(self.options) <= self.options_max_length
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This is like a cross between a button and a select menu - when a user clicks
on this overflow button, they will be presented with a list of options to
choose from. Unlike the select menu, there is no typeahead field, and the
@@ -2627,7 +2627,7 @@
Inherited members
menu, or to supply a list of less visually important actions after a row of
buttons. You can also specify simple URL links as overflow menu options,
instead of actions.
-https://api.slack.com/reference/block-kit/block-elements#overflow
+https://docs.slack.dev/reference/block-kit/block-elements/overflow-menu-element
Args
action_id : requiredInherited members
where a user can enter freeform data. It can appear as a single-line
field or a larger textarea using the multiline flag. Plain-text input
elements can be used inside of SectionBlocks and ActionsBlocks.
- https://api.slack.com/reference/block-kit/block-elements#input
+ https://docs.slack.dev/reference/block-kit/block-elements/plain-text-input-element
Args:
action_id (required): An identifier for the input value when the parent modal is submitted.
@@ -2756,12 +2756,12 @@ Inherited members
self.dispatch_action_config = dispatch_action_config
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A plain-text input, similar to the HTML tag, creates a field
where a user can enter freeform data. It can appear as a single-line
field or a larger textarea using the multiline flag. Plain-text input
elements can be used inside of SectionBlocks and ActionsBlocks.
-https://api.slack.com/reference/block-kit/block-elements#input
+https://docs.slack.dev/reference/block-kit/block-elements/plain-text-input-element
Args
action_id : requiredInherited members
**others: dict,
):
"""A radio button group that allows a user to choose one item from a list of possible options.
- https://api.slack.com/reference/block-kit/block-elements#radio
+ https://docs.slack.dev/reference/block-kit/block-elements/radio-button-group-element
Args:
action_id (required): An identifier for the action triggered when the radio button group is changed.
@@ -2896,9 +2896,9 @@ Inherited members
self.initial_option = initial_option
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A radio button group that allows a user to choose one item from a list of possible options.
-https://api.slack.com/reference/block-kit/block-elements#radio
+https://docs.slack.dev/reference/block-kit/block-elements/radio-button-group-element
Args
action_id : requiredInherited members
pass
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- BlockElement
@@ -3246,42 +3246,42 @@ Class variables
var Broadcast-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Channel-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Color-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Date-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Emoji-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Link-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Team-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var Text-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var TextStyle-
@@ -3290,12 +3290,12 @@
Class variables
var User-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
var UserGroup-
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
@@ -3343,7 +3343,7 @@ Class variables
self.dispatch_action_config = dispatch_action_config
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
InteractiveElement that is usable in input blocks
We generally recommend using the concrete subclasses for better supports of available properties.
Ancestors
@@ -3430,7 +3430,7 @@ Inherited members
self.border = border
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- RichTextElement
@@ -3501,7 +3501,7 @@ Inherited members
self.border = border
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- RichTextElement
@@ -3570,7 +3570,7 @@ Inherited members
self.elements = BlockElement.parse_all(elements)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- RichTextElement
@@ -3639,7 +3639,7 @@ Inherited members
self.elements = BlockElement.parse_all(elements)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- RichTextElement
@@ -3712,7 +3712,7 @@ Inherited members
**others: dict,
):
"""This is the simplest form of select menu, with a static list of options passed in when defining the element.
- https://api.slack.com/reference/block-kit/block-elements#static_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#static_select
Args:
action_id (required): An identifier for the action triggered when a menu option is selected.
@@ -3764,9 +3764,9 @@ Inherited members
return self.options is not None or self.option_groups is not None
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This is the simplest form of select menu, with a static list of options passed in when defining the element.
-https://api.slack.com/reference/block-kit/block-elements#static_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#static_select
Args
action_id : requiredInherited members
):
"""
This is the simplest form of select menu, with a static list of options passed in when defining the element.
- https://api.slack.com/reference/block-kit/block-elements#static_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#static_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -3935,9 +3935,9 @@ Inherited members
return self.options is not None or self.option_groups is not None
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This is the simplest form of select menu, with a static list of options passed in when defining the element.
-https://api.slack.com/reference/block-kit/block-elements#static_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#static_multi_select
Args
placeholder : requiredInherited members
**others: dict,
):
"""This is the simplest form of select menu, with a static list of options passed in when defining the element.
- https://api.slack.com/reference/block-kit/block-elements#static_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#static_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -4104,9 +4104,9 @@ Inherited members
return self.options is not None or self.option_groups is not None
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This is the simplest form of select menu, with a static list of options passed in when defining the element.
-https://api.slack.com/reference/block-kit/block-elements#static_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#static_select
Args
placeholder : requiredInherited members
On desktop clients, this time picker will take the form of a dropdown list
with free-text entry for precise choices.
On mobile clients, the time picker will use native time picker UIs.
- https://api.slack.com/reference/block-kit/block-elements#timepicker
+ https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element
Args:
action_id (required): An identifier for the action triggered when a time is selected.
@@ -4254,12 +4254,12 @@ Inherited members
return self.initial_time is None or re.match(r"([0-1][0-9]|2[0-3]):([0-5][0-9])", self.initial_time) is not None
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An element which allows selection of a time of day.
On desktop clients, this time picker will take the form of a dropdown list
with free-text entry for precise choices.
On mobile clients, the time picker will use native time picker UIs.
-https://api.slack.com/reference/block-kit/block-elements#timepicker
+https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element
Args
action_id : requiredInherited members
"""
A URL input element, similar to the Plain-text input element,
creates a single line field where a user can enter URL-encoded data.
- https://api.slack.com/reference/block-kit/block-elements#url
+ https://docs.slack.dev/reference/block-kit/block-elements/url-input-element
Args:
action_id (required): An identifier for the input value when the parent modal is submitted.
@@ -4388,10 +4388,10 @@ Inherited members
self.dispatch_action_config = dispatch_action_config
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A URL input element, similar to the Plain-text input element,
creates a single line field where a user can enter URL-encoded data.
-https://api.slack.com/reference/block-kit/block-elements#url
+https://docs.slack.dev/reference/block-kit/block-elements/url-input-element
Args
action_id : requiredInherited members
"""
This select menu will populate its options with a list of Slack users visible to
the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#users_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#users_multi_select
Args:
action_id (required): An identifier for the action triggered when a menu option is selected.
@@ -4520,10 +4520,10 @@ Inherited members
self.max_selected_items = max_selected_items
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of Slack users visible to
the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#users_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#users_multi_select
Args
action_id : requiredInherited members
"""
This select menu will populate its options with a list of Slack users visible to
the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#users_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#users_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -4646,10 +4646,10 @@ Inherited members
self.initial_user = initial_user
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of Slack users visible to
the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#users_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element#users_select
Args
placeholder : requiredInherited members
"""Allows users to run a link trigger with customizable inputs
Interactive component - but interactions with workflow button elements will not send block_actions events,
since these are used to start new workflow runs.
- https://api.slack.com/reference/block-kit/block-elements#workflow_button
+ https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element
Args:
text (required): A text object that defines the button's text.
@@ -4774,11 +4774,11 @@ Inherited members
self.accessibility_label = accessibility_label
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Allows users to run a link trigger with customizable inputs
Interactive component - but interactions with workflow button elements will not send block_actions events,
since these are used to start new workflow runs.
-https://api.slack.com/reference/block-kit/block-elements#workflow_button
+https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element
Args
text : requiredClasses
**others: dict,
):
"""A block that is used to hold interactive elements.
- https://api.slack.com/reference/block-kit/blocks#actions
+ https://docs.slack.dev/reference/block-kit/blocks/actions-block
Args:
elements (required): An array of interactive element objects - buttons, select menus, overflow menus,
@@ -94,9 +94,9 @@ Classes
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A block that is used to hold interactive elements.
-https://api.slack.com/reference/block-kit/blocks#actions
+https://docs.slack.dev/reference/block-kit/blocks/actions-block
Args
elements : requiredInherited members
class Block(JsonObject):
"""Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
- https://api.slack.com/reference/block-kit/blocks
+ https://docs.slack.dev/reference/block-kit/blocks
"""
attributes = {"block_id", "type"}
@@ -228,6 +228,8 @@ Inherited members
return CallBlock(**block)
elif type == HeaderBlock.type:
return HeaderBlock(**block)
+ elif type == MarkdownBlock.type:
+ return MarkdownBlock(**block)
elif type == VideoBlock.type:
return VideoBlock(**block)
elif type == RichTextBlock.type:
@@ -245,7 +247,7 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Ancestors
- JsonObject
@@ -261,6 +263,7 @@ Subclasses
- HeaderBlock
- ImageBlock
- InputBlock
+- MarkdownBlock
- RichTextBlock
- SectionBlock
- VideoBlock
@@ -347,7 +350,7 @@ Inherited members
**others: dict,
):
"""Displays a call information
- https://api.slack.com/reference/block-kit/blocks#call
+ https://docs.slack.dev/reference/block-kit/blocks#call
"""
super().__init__(type=self.type, block_id=block_id)
show_unknown_key_warning(self, others)
@@ -358,9 +361,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Displays a call information
-https://api.slack.com/reference/block-kit/blocks#call
+https://docs.slack.dev/reference/block-kit/blocks#call
Ancestors
- Block
@@ -427,7 +430,7 @@ Inherited members
**others: dict,
):
"""Displays message context, which can include both images and text.
- https://api.slack.com/reference/block-kit/blocks#context
+ https://docs.slack.dev/reference/block-kit/blocks/context-block
Args:
elements (required): An array of image elements and text objects. Maximum number of items is 10.
@@ -447,9 +450,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Displays message context, which can include both images and text.
-https://api.slack.com/reference/block-kit/blocks#context
+https://docs.slack.dev/reference/block-kit/blocks/context-block
Args
elements : requiredInherited members
**others: dict,
):
"""A content divider, like an <hr>, to split up different blocks inside of a message.
- https://api.slack.com/reference/block-kit/blocks#divider
+ https://docs.slack.dev/reference/block-kit/blocks/divider-block
Args:
block_id: A string acting as a unique identifier for a block. If not specified, one will be generated.
@@ -538,9 +541,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A content divider, like an
, to split up different blocks inside of a message.
-https://api.slack.com/reference/block-kit/blocks#divider
+https://docs.slack.dev/reference/block-kit/blocks/divider-block
Args
block_idInherited members
**others: dict,
):
"""Displays a remote file.
- https://api.slack.com/reference/block-kit/blocks#file
+ https://docs.slack.dev/reference/block-kit/blocks/file-block
Args:
external_id (required): The external unique ID for this file.
@@ -620,9 +623,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Displays a remote file.
-https://api.slack.com/reference/block-kit/blocks#file
+https://docs.slack.dev/reference/block-kit/blocks/file-block
Args
external_id : requiredInherited members
**others: dict,
):
"""A header is a plain-text block that displays in a larger, bold font.
- https://api.slack.com/reference/block-kit/blocks#header
+ https://docs.slack.dev/reference/block-kit/blocks/header-block
Args:
block_id: A string acting as a unique identifier for a block. If not specified, one will be generated.
@@ -726,9 +729,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A header is a plain-text block that displays in a larger, bold font.
-https://api.slack.com/reference/block-kit/blocks#header
+https://docs.slack.dev/reference/block-kit/blocks/header-block
Args
block_idInherited members
**others: dict,
):
"""A simple image block, designed to make those cat photos really pop.
- https://api.slack.com/reference/block-kit/blocks#image
+ https://docs.slack.dev/reference/block-kit/blocks/image-block
Args:
alt_text (required): A plain-text summary of the image. This should not contain any markup.
@@ -868,9 +871,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A simple image block, designed to make those cat photos really pop.
-https://api.slack.com/reference/block-kit/blocks#image
+https://docs.slack.dev/reference/block-kit/blocks/image-block
Args
alt_text : requiredInherited members
):
"""A block that collects information from users - it can hold a plain-text input element,
a select menu element, a multi-select menu element, or a datepicker.
- https://api.slack.com/reference/block-kit/blocks#input
+ https://docs.slack.dev/reference/block-kit/blocks/input-block
Args:
label (required): A label that appears above an input element in the form of a text object
@@ -1021,10 +1024,10 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A block that collects information from users - it can hold a plain-text input element,
a select menu element, a multi-select menu element, or a datepicker.
-https://api.slack.com/reference/block-kit/blocks#input
+https://docs.slack.dev/reference/block-kit/blocks/input-block
Args
label : requiredInherited members
+
+class MarkdownBlock
+(*, text: str, block_id: str | None = None, **others: dict)
+-
+
+
+Expand source code
+
+class MarkdownBlock(Block):
+ type = "markdown"
+ text_max_length = 12000
+
+ @property
+ def attributes(self) -> Set[str]: # type: ignore[override]
+ return super().attributes.union({"text"})
+
+ def __init__(
+ self,
+ *,
+ text: str,
+ block_id: Optional[str] = None,
+ **others: dict,
+ ):
+ """Displays formatted markdown.
+ https://docs.slack.dev/reference/block-kit/blocks/markdown-block/
+
+ Args:
+ block_id: A string acting as a unique identifier for a block. If not specified, one will be generated.
+ Maximum length for this field is 255 characters.
+ block_id should be unique for each message and each iteration of a message.
+ If a message is updated, use a new block_id.
+ text (required): The standard markdown-formatted text. Limit 12,000 characters max.
+ """
+ super().__init__(type=self.type, block_id=block_id)
+ show_unknown_key_warning(self, others)
+
+ self.text = text
+
+ @JsonValidator("text attribute must be specified")
+ def _validate_text(self):
+ return self.text != ""
+
+ @JsonValidator(f"text attribute cannot exceed {text_max_length} characters")
+ def _validate_alt_text_length(self):
+ return len(self.text) <= self.text_max_length
+
+Blocks are a series of components that can be combined
+to create visually rich and compellingly interactive messages.
+https://docs.slack.dev/reference/block-kit/blocks
+Displays formatted markdown.
+https://docs.slack.dev/reference/block-kit/blocks/markdown-block/
+Args
+
+block_id- A string acting as a unique identifier for a block. If not specified, one will be generated.
+Maximum length for this field is 255 characters.
+block_id should be unique for each message and each iteration of a message.
+If a message is updated, use a new block_id.
+text : required- The standard markdown-formatted text. Limit 12,000 characters max.
+
+Ancestors
+
+- Block
+- JsonObject
+- BaseObject
+
+Class variables
+
+var text_max_length-
+
The type of the None singleton.
+
+var type-
+
The type of the None singleton.
+
+
+Instance variables
+
+prop attributes : Set[str]-
+
+
+Expand source code
+
+@property
+def attributes(self) -> Set[str]: # type: ignore[override]
+ return super().attributes.union({"text"})
+
+Build an unordered collection of unique elements.
+
+
+Inherited members
+
+Block:
+
+
+
class RichTextBlock
(*,
elements: Sequence[dict | RichTextElement],
block_id: str | None = None,
**others: dict)
@@ -1122,7 +1232,7 @@ Inherited members
**others: dict,
):
"""A block that is used to hold interactive elements.
- https://api.slack.com/reference/block-kit/blocks#rich_text
+ https://docs.slack.dev/reference/block-kit/blocks/rich-text-block
Args:
elements (required): An array of rich text objects -
@@ -1139,9 +1249,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A block that is used to hold interactive elements.
-https://api.slack.com/reference/block-kit/blocks#rich_text
+https://docs.slack.dev/reference/block-kit/blocks/rich-text-block
Args
elements : requiredInherited members
**others: dict,
):
"""A section is one of the most flexible blocks available.
- https://api.slack.com/reference/block-kit/blocks#section
+ https://docs.slack.dev/reference/block-kit/blocks/section-block
Args:
block_id (required): A string acting as a unique identifier for a block.
@@ -1282,9 +1392,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A section is one of the most flexible blocks available.
-https://api.slack.com/reference/block-kit/blocks#section
+https://docs.slack.dev/reference/block-kit/blocks/section-block
Args
block_id : requiredInherited members
(e.g. link unfurls, messages, modals, App Home) —
anywhere you can put blocks! To use the video block within your app,
you must have the links.embed:write scope.
- https://api.slack.com/reference/block-kit/blocks#video
+ https://docs.slack.dev/reference/block-kit/blocks/video-block
Args:
block_id: A string acting as a unique identifier for a block. If not specified, one will be generated.
@@ -1467,12 +1577,12 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A video block is designed to embed videos in all app surfaces
(e.g. link unfurls, messages, modals, App Home) —
anywhere you can put blocks! To use the video block within your app,
you must have the links.embed:write scope.
-https://api.slack.com/reference/block-kit/blocks#video
+https://docs.slack.dev/reference/block-kit/blocks/video-block
Args
block_idMarkdownBlock
+
+
+
-
RichTextBlock
attributesModule slack_sdk.models.blocks
Block Kit data model objects
To learn more about Block Kit, please check the following resources and tools:
-- https://api.slack.com/block-kit
-- https://api.slack.com/reference/block-kit/blocks
+- https://docs.slack.dev/block-kit/
+- https://docs.slack.dev/reference/block-kit/blocks
- https://app.slack.com/block-kit-builder
@@ -93,7 +93,7 @@ Classes
**others: dict,
):
"""A block that is used to hold interactive elements.
- https://api.slack.com/reference/block-kit/blocks#actions
+ https://docs.slack.dev/reference/block-kit/blocks/actions-block
Args:
elements (required): An array of interactive element objects - buttons, select menus, overflow menus,
@@ -116,9 +116,9 @@ Classes
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
A block that is used to hold interactive elements.
-https://api.slack.com/reference/block-kit/blocks#actions
+https://docs.slack.dev/reference/block-kit/blocks/actions-block
Args
elements : requiredInherited members
class Block(JsonObject):
"""Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
- https://api.slack.com/reference/block-kit/blocks
+ https://docs.slack.dev/reference/block-kit/blocks
"""
attributes = {"block_id", "type"}
@@ -250,6 +250,8 @@ Inherited members
return CallBlock(**block)
elif type == HeaderBlock.type:
return HeaderBlock(**block)
+ elif type == MarkdownBlock.type:
+ return MarkdownBlock(**block)
elif type == VideoBlock.type:
return VideoBlock(**block)
elif type == RichTextBlock.type:
@@ -267,7 +269,7 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Ancestors
- JsonObject
@@ -283,6 +285,7 @@ Subclasses
- HeaderBlock
- ImageBlock
- InputBlock
+- MarkdownBlock
- RichTextBlock
- SectionBlock
- VideoBlock
@@ -354,7 +357,7 @@ Inherited members
class BlockElement(JsonObject, metaclass=ABCMeta):
"""Block Elements are things that exists inside of your Blocks.
- https://api.slack.com/reference/block-kit/block-elements
+ https://docs.slack.dev/reference/block-kit/block-elements/
"""
attributes = {"type"}
@@ -416,7 +419,7 @@ Inherited members
yield from subclass._get_sub_block_elements()
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
Ancestors
- JsonObject
@@ -513,7 +516,7 @@ Inherited members
):
"""An interactive element that inserts a button. The button can be a trigger for
anything from opening a simple link to starting a complex workflow.
- https://api.slack.com/reference/block-kit/block-elements#button
+ https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args:
text (required): A text object that defines the button's text.
@@ -572,10 +575,10 @@ Inherited members
return self.accessibility_label is None or len(self.accessibility_label) <= self.text_max_length
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
An interactive element that inserts a button. The button can be a trigger for
anything from opening a simple link to starting a complex workflow.
-https://api.slack.com/reference/block-kit/block-elements#button
+https://docs.slack.dev/reference/block-kit/block-elements/button-element/
Args
text : requiredInherited members
**others: dict,
):
"""Displays a call information
- https://api.slack.com/reference/block-kit/blocks#call
+ https://docs.slack.dev/reference/block-kit/blocks#call
"""
super().__init__(type=self.type, block_id=block_id)
show_unknown_key_warning(self, others)
@@ -690,9 +693,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Displays a call information
-https://api.slack.com/reference/block-kit/blocks#call
+https://docs.slack.dev/reference/block-kit/blocks#call
Ancestors
- Block
@@ -764,7 +767,7 @@ Inherited members
"""
This multi-select menu will populate its options with a list of public channels visible
to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#channel_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -795,10 +798,10 @@ Inherited members
self.max_selected_items = max_selected_items
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This multi-select menu will populate its options with a list of public channels visible
to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#channel_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#channel_multi_select
Args
placeholder : requiredInherited members
"""
This select menu will populate its options with a list of public channels
visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#channel_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#channels_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -928,10 +931,10 @@ Inherited members
self.response_url_enabled = response_url_enabled
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of public channels
visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#channel_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#channels_select
Args
placeholder : requiredInherited members
**others: dict,
):
"""A checkbox group that allows a user to choose multiple items from a list of possible options.
- https://api.slack.com/reference/block-kit/block-elements#checkboxes
+ https://docs.slack.dev/reference/block-kit/block-elements/checkboxes-element/
Args:
action_id (required): An identifier for the action triggered when the checkbox group is changed.
@@ -1054,9 +1057,9 @@ Inherited members
self.initial_options = Option.parse_all(initial_options)
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
A checkbox group that allows a user to choose multiple items from a list of possible options.
-https://api.slack.com/reference/block-kit/block-elements#checkboxes
+https://docs.slack.dev/reference/block-kit/block-elements/checkboxes-element/
Args
action_id : requiredInherited members
Expand source code
class ConfirmObject(JsonObject):
- attributes = {} # type: ignore[assignment] # no attributes because to_dict has unique implementations
+ attributes: Set[str] = set()
title_max_length = 100
text_max_length = 300
@@ -1162,7 +1165,7 @@ Inherited members
An object that defines a dialog that provides a confirmation step to any
interactive element. This dialog will ask the user to confirm their action by
offering a confirm and deny button.
- https://api.slack.com/reference/block-kit/composition-objects#confirm
+ https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object/
"""
self._title = TextObject.parse(title, default_type=PlainTextObject.type)
self._text = TextObject.parse(text, default_type=MarkdownTextObject.type)
@@ -1230,7 +1233,7 @@ Inherited members
An object that defines a dialog that provides a confirmation step to any
interactive element. This dialog will ask the user to confirm their action by
offering a confirm and deny button.
-https://api.slack.com/reference/block-kit/composition-objects#confirm
+https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object/
Ancestors
- JsonObject
@@ -1238,7 +1241,7 @@ Ancestors
Class variables
-var attributesvar attributes : Set[str]-
The type of the None singleton.
@@ -1363,7 +1366,7 @@ Inherited members
**others: dict,
):
"""Displays message context, which can include both images and text.
- https://api.slack.com/reference/block-kit/blocks#context
+ https://docs.slack.dev/reference/block-kit/blocks/context-block
Args:
elements (required): An array of image elements and text objects. Maximum number of items is 10.
@@ -1383,9 +1386,9 @@ Inherited members
Blocks are a series of components that can be combined
to create visually rich and compellingly interactive messages.
-https://api.slack.com/reference/block-kit/blocks
+https://docs.slack.dev/reference/block-kit/blocks
Displays message context, which can include both images and text.
-https://api.slack.com/reference/block-kit/blocks#context
+https://docs.slack.dev/reference/block-kit/blocks/context-block
Args
elements : requiredInherited members
):
"""Provides a way to filter the list of options in a conversations select menu
or conversations multi-select menu.
- https://api.slack.com/reference/block-kit/composition-objects#filter_conversations
+ https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object
Args:
include: Indicates which type of conversations should be included in the list.
@@ -1494,7 +1497,7 @@ Inherited members
The base class for JSON serializable class objects
Provides a way to filter the list of options in a conversations select menu
or conversations multi-select menu.
-https://api.slack.com/reference/block-kit/composition-objects#filter_conversations
+https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object
Args
includeInherited members
"""
This multi-select menu will populate its options with a list of public and private channels,
DMs, and MPIMs visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+ https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element/#conversation_multi_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -1620,10 +1623,10 @@ Inherited members
self.filter = ConversationFilter.parse(filter) # type: ignore[arg-type]
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This multi-select menu will populate its options with a list of public and private channels,
DMs, and MPIMs visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select
+https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element/#conversation_multi_select
Args
placeholder : requiredInherited members
"""
This select menu will populate its options with a list of public and private
channels, DMs, and MPIMs visible to the current user in the active workspace.
- https://api.slack.com/reference/block-kit/block-elements#conversation_select
+ https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#conversations_select
Args:
placeholder (required): A plain_text only text object that defines the placeholder text shown on the menu.
@@ -1781,10 +1784,10 @@ Inherited members
self.filter = filter
Block Elements are things that exists inside of your Blocks.
-https://api.slack.com/reference/block-kit/block-elements
+https://docs.slack.dev/reference/block-kit/block-elements/
This select menu will populate its options with a list of public and private
channels, DMs, and MPIMs visible to the current user in the active workspace.
-https://api.slack.com/reference/block-kit/block-elements#conversation_select
+https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element/#conversations_select
Args