logger: Optional[logging.Logger] = None,
retry_handlers: Optional[List[AsyncRetryHandler]] = None,
):
- """API client for Audit Logs API
+ """API client for Audit Logs API.
+
See https://docs.slack.dev/admins/audit-logs-api/ for more details
Args:
@@ -128,9 +129,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -150,9 +151,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -181,6 +182,7 @@
Classes
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -388,8 +390,8 @@
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -504,9 +506,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of actions that the Audit Logs API
-returns as a list of all actions and a short description of each.
-Authentication not required.
+
Returns information about the kind of actions the Audit Logs API returns.
+
Returned as a list of all actions, each with a short description. Authentication not required.
Args
-----=
@@ -573,6 +574,7 @@
Methods
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -614,8 +616,8 @@
Methods
headers=headers,
)
-
This is the primary endpoint for retrieving actual audit events from your organization.
-It will return a list of actions that have occurred on the installed workspace or grid organization.
+
This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
@@ -662,9 +664,9 @@
Methods
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -678,9 +680,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of objects which the Audit Logs API
-returns as a list of all objects and a short description.
-Authentication not required.
+
Returns information about the kind of objects the Audit Logs API returns.
+
Returned as a list of all objects, each with a short description. Authentication not required.
logger: Optional[logging.Logger] = None,
retry_handlers: Optional[List[RetryHandler]] = None,
):
- """API client for Audit Logs API
+ """API client for Audit Logs API.
+
See https://docs.slack.dev/admins/audit-logs-api/ for more details
Args:
@@ -129,9 +130,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -151,9 +152,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -182,6 +183,7 @@
Classes
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -401,8 +403,8 @@
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -499,9 +501,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of actions that the Audit Logs API
-returns as a list of all actions and a short description of each.
-Authentication not required.
+
Returns information about the kind of actions the Audit Logs API returns.
+
Returned as a list of all actions, each with a short description. Authentication not required.
Args
-----=
@@ -572,6 +573,7 @@
Methods
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -613,8 +615,8 @@
Methods
headers=headers,
)
-
This is the primary endpoint for retrieving actual audit events from your organization.
-It will return a list of actions that have occurred on the installed workspace or grid organization.
+
This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
@@ -661,9 +663,9 @@
Methods
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -677,9 +679,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of objects which the Audit Logs API
-returns as a list of all objects and a short description.
-Authentication not required.
+
Returns information about the kind of objects the Audit Logs API returns.
+
Returned as a list of all objects, each with a short description. Authentication not required.
logger: Optional[logging.Logger] = None,
retry_handlers: Optional[List[AsyncRetryHandler]] = None,
):
- """API client for Audit Logs API
+ """API client for Audit Logs API.
+
See https://docs.slack.dev/admins/audit-logs-api/ for more details
Args:
@@ -130,9 +131,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -152,9 +153,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -183,6 +184,7 @@
Classes
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -390,8 +392,8 @@
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -506,9 +508,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of actions that the Audit Logs API
-returns as a list of all actions and a short description of each.
-Authentication not required.
+
Returns information about the kind of actions the Audit Logs API returns.
+
Returned as a list of all actions, each with a short description. Authentication not required.
Args
-----=
@@ -575,6 +576,7 @@
Methods
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -616,8 +618,8 @@
Methods
headers=headers,
)
-
This is the primary endpoint for retrieving actual audit events from your organization.
-It will return a list of actions that have occurred on the installed workspace or grid organization.
+
This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
@@ -664,9 +666,9 @@
Methods
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -680,9 +682,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of objects which the Audit Logs API
-returns as a list of all objects and a short description.
-Authentication not required.
+
Returns information about the kind of objects the Audit Logs API returns.
+
Returned as a list of all objects, each with a short description. Authentication not required.
logger: Optional[logging.Logger] = None,
retry_handlers: Optional[List[RetryHandler]] = None,
):
- """API client for Audit Logs API
+ """API client for Audit Logs API.
+
See https://docs.slack.dev/admins/audit-logs-api/ for more details
Args:
@@ -118,9 +119,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -140,9 +141,9 @@
Classes
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -171,6 +172,7 @@
Classes
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -390,8 +392,8 @@
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of actions that the Audit Logs API
- returns as a list of all actions and a short description of each.
- Authentication not required.
+ """Returns information about the kind of actions the Audit Logs API returns.
+
+ Returned as a list of all actions, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -488,9 +490,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of actions that the Audit Logs API
-returns as a list of all actions and a short description of each.
-Authentication not required.
+
Returns information about the kind of actions the Audit Logs API returns.
+
Returned as a list of all actions, each with a short description. Authentication not required.
Args
-----=
@@ -561,6 +562,7 @@
Methods
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
"""This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
@@ -602,8 +604,8 @@
Methods
headers=headers,
)
-
This is the primary endpoint for retrieving actual audit events from your organization.
-It will return a list of actions that have occurred on the installed workspace or grid organization.
+
This is the primary endpoint for retrieving actual audit events from your organization.
+
It will return a list of actions that have occurred on the installed workspace or grid organization.
Authentication required.
The following filters can be applied in order to narrow the range of actions returned.
Filters are added as query string parameters and can be combined together.
@@ -650,9 +652,9 @@
Methods
query_params: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
) -> AuditLogsResponse:
- """Returns information about the kind of objects which the Audit Logs API
- returns as a list of all objects and a short description.
- Authentication not required.
+ """Returns information about the kind of objects the Audit Logs API returns.
+
+ Returned as a list of all objects, each with a short description. Authentication not required.
Args:
query_params: Set any values if you want to add query params
@@ -666,9 +668,8 @@
Methods
headers=headers,
)
-
Returns information about the kind of objects which the Audit Logs API
-returns as a list of all objects and a short description.
-Authentication not required.
+
Returns information about the kind of objects the Audit Logs API returns.
+
Returned as a list of all objects, each with a short description. Authentication not required.
class BotUserAccessError(SlackClientError):
- """Error raised when an 'xoxb-*' token is
- being used for a Slack API method that only accepts 'xoxp-*' tokens.
- """
+ """Error raised when an 'xoxb-*' token is being used for a Slack API method that only accepts 'xoxp-*' tokens."""
-
Error raised when an 'xoxb-' token is
-being used for a Slack API method that only accepts 'xoxp-' tokens.
+
Error raised when an 'xoxb-' token is being used for a Slack API method that only accepts 'xoxp-' tokens.
class SlackClientConfigurationError(SlackClientError):
- """Error raised because of invalid configuration on the client side:
+ """Error raised because of invalid configuration on the client side.
+
* when attempting to send messages over the websocket when the connection is closed.
* when external system (e.g., Amazon S3) configuration / credentials are not correct
"""
-
Error raised because of invalid configuration on the client side:
-* when attempting to send messages over the websocket when the connection is closed.
-* when external system (e.g., Amazon S3) configuration / credentials are not correct
+
Error raised because of invalid configuration on the client side.
+
+
when attempting to send messages over the websocket when the connection is closed.
+
when external system (e.g., Amazon S3) configuration / credentials are not correct
class SlackClientError(Exception):
- """Base class for Client errors"""
+ """Base class for Client errors."""
-
Base class for Client errors
+
Base class for Client errors.
Ancestors
builtins.Exception
@@ -179,11 +179,9 @@
Subclasses
Expand source code
class SlackClientNotConnectedError(SlackClientError):
- """Error raised when attempting to send messages over the websocket when the
- connection is closed."""
+ """Error raised when attempting to send messages over the websocket when the connection is closed."""
-
Error raised when attempting to send messages over the websocket when the
-connection is closed.
+
Error raised when attempting to send messages over the websocket when the connection is closed.
class SlackTokenRotationError(SlackClientError):
- """Error raised when the oauth.v2.access call for token rotation fails"""
+ """Error raised when the oauth.v2.access call for token rotation fails."""
api_error: SlackApiError
def __init__(self, api_error: SlackApiError):
self.api_error = api_error
-
Error raised when the oauth.v2.access call for token rotation fails
+
Error raised when the oauth.v2.access call for token rotation fails.
asyncio compatible RetryHandler interface.
-You can pass an array of handlers to customize retry logics in supported API clients.
+
asyncio compatible RetryHandler interface.
+
You can pass an array of handlers to customize retry logics in supported API clients.
@@ -59,7 +58,8 @@
Classes
Expand source code
class BackoffRetryIntervalCalculator(RetryIntervalCalculator):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
+
see also: https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
"""
@@ -67,7 +67,7 @@
Classes
jitter: Jitter
def __init__(self, backoff_factor: float = 0.5, jitter: Optional[Jitter] = None):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
Args:
backoff_factor: The factor for the backoff interval calculation
@@ -81,9 +81,9 @@
class HttpResponse:
- """HTTP response representation"""
+ """HTTP response representation."""
status_code: int
headers: Dict[str, Union[List[str], str]]
@@ -222,7 +222,7 @@
Static methods
self.body = body
self.data = data
-
HTTP response representation
+
HTTP response representation.
Class variables
var body : Dict[str, Any] | None
@@ -259,6 +259,7 @@
Class variables
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
@@ -285,6 +286,7 @@
Methods
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
diff --git a/docs/reference/http_retry/builtin_interval_calculators.html b/docs/reference/http_retry/builtin_interval_calculators.html
index 77431f01f..c285ea26a 100644
--- a/docs/reference/http_retry/builtin_interval_calculators.html
+++ b/docs/reference/http_retry/builtin_interval_calculators.html
@@ -56,7 +56,8 @@
Classes
Expand source code
class BackoffRetryIntervalCalculator(RetryIntervalCalculator):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
+
see also: https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
"""
@@ -64,7 +65,7 @@
Classes
jitter: Jitter
def __init__(self, backoff_factor: float = 0.5, jitter: Optional[Jitter] = None):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
Args:
backoff_factor: The factor for the backoff interval calculation
@@ -78,9 +79,9 @@
RetryHandler interface.
-You can pass an array of handlers to customize retry logics in supported API clients.
+
RetryHandler interface.
+
You can pass an array of handlers to customize retry logics in supported API clients.
@@ -60,6 +59,7 @@
Classes
class RetryHandler:
"""RetryHandler interface.
+
You can pass an array of handlers to customize retry logics in supported API clients.
"""
@@ -120,8 +120,8 @@
class BackoffRetryIntervalCalculator(RetryIntervalCalculator):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
+
see also: https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
"""
@@ -141,7 +140,7 @@
Classes
jitter: Jitter
def __init__(self, backoff_factor: float = 0.5, jitter: Optional[Jitter] = None):
- """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter
+ """Retry interval calculator that calculates in the manner of Exponential Backoff And Jitter.
Args:
backoff_factor: The factor for the backoff interval calculation
@@ -155,9 +154,9 @@
class RetryHandler:
"""RetryHandler interface.
+
You can pass an array of handlers to customize retry logics in supported API clients.
"""
@@ -686,8 +688,8 @@
RetryHandler interface.
-You can pass an array of handlers to customize retry logics in supported API clients.
+
RetryHandler interface.
+
You can pass an array of handlers to customize retry logics in supported API clients.
RetryHandler interface.
Args
@@ -784,6 +786,7 @@
Methods
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
@@ -810,6 +813,7 @@
Methods
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
diff --git a/docs/reference/http_retry/interval_calculator.html b/docs/reference/http_retry/interval_calculator.html
index 37ddc6958..2ddb6408e 100644
--- a/docs/reference/http_retry/interval_calculator.html
+++ b/docs/reference/http_retry/interval_calculator.html
@@ -62,6 +62,7 @@
Classes
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
@@ -88,6 +89,7 @@
Methods
Args:
current_attempt: the number of the current attempt (zero-origin; 0 means no retries are done so far)
+
Returns:
calculated interval duration in seconds
"""
diff --git a/docs/reference/http_retry/jitter.html b/docs/reference/http_retry/jitter.html
index 8fb121a76..9c6324f27 100644
--- a/docs/reference/http_retry/jitter.html
+++ b/docs/reference/http_retry/jitter.html
@@ -55,10 +55,11 @@
Classes
Expand source code
class Jitter:
- """Jitter interface"""
+ """Jitter interface."""
def recalculate(self, duration: float) -> float:
"""Recalculate the given duration.
+
see also: https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
Args:
@@ -69,7 +70,7 @@
SCIM API is a set of APIs for provisioning and managing user accounts and groups.
-SCIM is used by Single Sign-On (SSO) services and identity providers …
+
SCIM API is a set of APIs for provisioning and managing user accounts and groups …
You can use slack_sdk.webhook.WebhookClient for Incoming Webhooks
-and message responses using response_url in payloads.
+
You can use slack_sdk.webhook.WebhookClient for Incoming Webhooks and message responses using response_url in payloads.
@@ -233,7 +232,8 @@
Classes
metadata_only: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
- """Retrieve analytics data for a given date, presented as a compressed JSON file
+ """Retrieve analytics data for a given date, presented as a compressed JSON file.
+
https://docs.slack.dev/reference/methods/admin.analytics.getFile
"""
kwargs.update({"type": type})
@@ -253,6 +253,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Approve an app for installation on a workspace.
+
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.
@@ -283,6 +284,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List approved apps for an org or workspace.
+
https://docs.slack.dev/reference/methods/admin.apps.approved.list
"""
kwargs.update(
@@ -303,7 +305,8 @@
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
+
https://docs.slack.dev/reference/methods/admin.apps.requests.cancel
"""
kwargs.update(
@@ -344,6 +348,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
+
https://docs.slack.dev/reference/methods/admin.apps.requests.list
"""
kwargs.update(
@@ -365,6 +370,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Restrict an app for installation on a workspace.
+
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.
@@ -395,6 +401,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List restricted apps for an org or workspace.
+
https://docs.slack.dev/reference/methods/admin.apps.restricted.list
"""
kwargs.update(
@@ -416,6 +423,7 @@
Classes
**kwargs,
) -> 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://docs.slack.dev/reference/methods/admin.apps.uninstall
"""
@@ -447,7 +455,8 @@
Classes
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Get logs for a specified team/org
+ """Get logs for a specified team/org.
+
https://docs.slack.dev/reference/methods/admin.apps.activities.list
"""
kwargs.update(
@@ -475,7 +484,8 @@
Classes
app_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Look up the app config for connectors by their IDs
+ """Look up the app config for connectors by their IDs.
+
https://docs.slack.dev/reference/methods/admin.apps.config.lookup
"""
if isinstance(app_ids, (list, tuple)):
@@ -492,7 +502,8 @@
Classes
workflow_auth_strategy: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Set the app config for a connector
+ """Set the app config for a connector.
+
https://docs.slack.dev/reference/methods/admin.apps.config.set
"""
kwargs.update(
@@ -515,6 +526,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Fetch all the entities assigned to a particular authentication policy by name.
+
https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities
"""
kwargs.update({"policy_name": policy_name})
@@ -535,6 +547,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Assign entities to a particular authentication policy.
+
https://docs.slack.dev/reference/methods/admin.auth.policy.assignEntities
"""
if isinstance(entity_ids, (list, tuple)):
@@ -554,6 +567,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Remove specified entities from a specified authentication policy.
+
https://docs.slack.dev/reference/methods/admin.auth.policy.removeEntities
"""
if isinstance(entity_ids, (list, tuple)):
@@ -573,6 +587,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Create a Salesforce channel for the corresponding object provided.
+
https://docs.slack.dev/reference/methods/admin.conversations.createForObjects
"""
kwargs.update(
@@ -589,6 +604,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Link a Salesforce record to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.linkObjects
"""
kwargs.update(
@@ -608,6 +624,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Unlink a Salesforce record from a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.unlinkObjects
"""
kwargs.update(
@@ -626,7 +643,8 @@
Classes
restricted_subjects: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Create an Information Barrier
+ """Create an Information Barrier.
+
https://docs.slack.dev/reference/methods/admin.barriers.create
"""
kwargs.update({"primary_usergroup_id": primary_usergroup_id})
@@ -646,7 +664,8 @@
Classes
barrier_id: str,
**kwargs,
) -> SlackResponse:
- """Delete an existing Information Barrier
+ """Delete an existing Information Barrier.
+
https://docs.slack.dev/reference/methods/admin.barriers.delete
"""
kwargs.update({"barrier_id": barrier_id})
@@ -661,7 +680,8 @@
Classes
restricted_subjects: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Update an existing Information Barrier
+ """Update an existing Information Barrier.
+
https://docs.slack.dev/reference/methods/admin.barriers.update
"""
kwargs.update({"barrier_id": barrier_id, "primary_usergroup_id": primary_usergroup_id})
@@ -682,8 +702,10 @@
Classes
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Get all Information Barriers for your organization
- https://docs.slack.dev/reference/methods/admin.barriers.list"""
+ """Get all Information Barriers for your organization.
+
+ https://docs.slack.dev/reference/methods/admin.barriers.list
+ """
kwargs.update(
{
"cursor": cursor,
@@ -703,6 +725,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Create a public or private channel-based conversation.
+
https://docs.slack.dev/reference/methods/admin.conversations.create
"""
kwargs.update(
@@ -723,6 +746,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Delete a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.delete
"""
kwargs.update({"channel_id": channel_id})
@@ -736,6 +760,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Invite a user to a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.invite
"""
kwargs.update({"channel_id": channel_id})
@@ -753,6 +778,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Archive a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
@@ -765,6 +791,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Unarchive a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
@@ -778,6 +805,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Rename a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.rename
"""
kwargs.update({"channel_id": channel_id, "name": name})
@@ -796,6 +824,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Search for public or private channels in an Enterprise organization.
+
https://docs.slack.dev/reference/methods/admin.conversations.search
"""
kwargs.update(
@@ -827,6 +856,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Convert a public channel to a private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.convertToPrivate
"""
kwargs.update({"channel_id": channel_id})
@@ -839,6 +869,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Convert a privte channel to a public channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.convertToPublic
"""
kwargs.update({"channel_id": channel_id})
@@ -852,6 +883,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the posting permissions for a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
@@ -868,6 +900,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Get conversation preferences for a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.getConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
@@ -881,6 +914,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Disconnect a connected channel from one or more workspaces.
+
https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared
"""
kwargs.update({"channel_id": channel_id})
@@ -901,6 +935,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Returns channels on the given team using the filters.
+
https://docs.slack.dev/reference/methods/admin.conversations.lookup
"""
kwargs.update(
@@ -926,9 +961,9 @@
Classes
team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
- """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.
+ """List all disconnected channels and the corresponding original channel IDs for key revocation with EKM.
+
+ Disconnected channels are those that were once connected to other workspaces and then disconnected.
https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
"""
kwargs.update(
@@ -956,6 +991,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add an allowlist of IDP groups for accessing a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup
"""
kwargs.update(
@@ -979,6 +1015,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List all IDP Groups linked to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups
"""
kwargs.update(
@@ -1002,6 +1039,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Remove a linked IDP group linked from a private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.removeGroup
"""
kwargs.update(
@@ -1027,6 +1065,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.setTeams
"""
kwargs.update(
@@ -1051,6 +1090,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.getTeams
"""
kwargs.update(
@@ -1068,7 +1108,8 @@
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Look up functions by a set of apps
+ """Look up functions by a set of apps.
+
https://docs.slack.dev/reference/methods/admin.functions.list
"""
if isinstance(app_ids, (list, tuple)):
@@ -1236,8 +1288,9 @@
Classes
function_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Lookup the visibility of multiple Slack functions
- and include the users if it is limited to particular named entities.
+ """Lookup the visibility of multiple Slack functions.
+
+ Include the users if the visibility is limited to particular named entities.
https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup
"""
if isinstance(function_ids, (list, tuple)):
@@ -1254,8 +1307,8 @@
Classes
user_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
- """Set the visibility of a Slack function
- and define the users or workspaces if it is set to named_entities
+ """Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities.
+
https://docs.slack.dev/reference/methods/admin.functions.permissions.set
"""
kwargs.update(
@@ -1279,7 +1332,8 @@
Classes
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Adds members to the specified role with the specified scopes
+ """Adds members to the specified role with the specified scopes.
+
https://docs.slack.dev/reference/methods/admin.roles.addAssignments
"""
kwargs.update({"role_id": role_id})
@@ -1304,6 +1358,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists assignments for all roles across entities.
+
Options to scope results by any combination of roles or entities
https://docs.slack.dev/reference/methods/admin.roles.listAssignments
"""
@@ -1326,7 +1381,8 @@
Classes
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Removes a set of users from a role for the given scopes and entities
+ """Removes a set of users from a role for the given scopes and entities.
+
https://docs.slack.dev/reference/methods/admin.roles.removeAssignments
"""
kwargs.update({"role_id": role_id})
@@ -1349,6 +1405,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Wipes all valid sessions on all devices for a given user.
+
https://docs.slack.dev/reference/methods/admin.users.session.reset
"""
kwargs.update(
@@ -1368,7 +1425,8 @@
Classes
web_only: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
- """Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
+ """Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users.
+
https://docs.slack.dev/reference/methods/admin.users.session.resetBulk
"""
if isinstance(user_ids, (list, tuple)):
@@ -1391,6 +1449,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Invalidate a single session for a user by session_id.
+
https://docs.slack.dev/reference/methods/admin.users.session.invalidate
"""
kwargs.update({"session_id": session_id, "team_id": team_id})
@@ -1405,7 +1464,8 @@
Classes
user_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Lists all active user sessions for an organization
+ """Lists all active user sessions for an organization.
+
https://docs.slack.dev/reference/methods/admin.users.session.list
"""
kwargs.update(
@@ -1426,6 +1486,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the default channels of a workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.setDefaultChannels
"""
kwargs.update({"team_id": team_id})
@@ -1441,8 +1502,9 @@
Classes
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Get user-specific session settings—the session duration
- and what happens when the client closes—given a list of users.
+ """Get user-specific session settings for a given list of users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.getSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -1459,8 +1521,9 @@
Classes
duration: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Configure the user-level session settings—the session duration
- and what happens when the client closes—for one or more users.
+ """Configure the user-level session settings for one or more users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.setSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -1481,8 +1544,9 @@
Classes
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Clear user-specific session settings—the session duration
- and what happens when the client closes—for a list of users.
+ """Clear user-specific session settings for a list of users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.clearSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -1498,8 +1562,9 @@
Classes
date_sessions_started: Optional[Union[str, int]] = None,
**kwargs,
) -> SlackResponse:
- """Ask Slackbot to send you an export listing all workspace members using unsupported software,
- presented as a zipped CSV file.
+ """Ask Slackbot to send you an export listing all workspace members using unsupported software.
+
+ The export is presented as a zipped CSV file.
https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export
"""
kwargs.update(
@@ -1518,6 +1583,7 @@
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
+
https://docs.slack.dev/reference/methods/admin.inviteRequests.list
"""
kwargs.update(
@@ -1613,6 +1683,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Create an Enterprise team.
+
https://docs.slack.dev/reference/methods/admin.teams.create
"""
kwargs.update(
@@ -1633,6 +1704,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List all teams on an Enterprise organization.
+
https://docs.slack.dev/reference/methods/admin.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit})
@@ -1647,6 +1719,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.owners.list
"""
kwargs.update({"team_id": team_id, "cursor": cursor, "limit": limit})
@@ -1658,7 +1731,8 @@
Classes
team_id: str,
**kwargs,
) -> SlackResponse:
- """Fetch information about settings in a workspace
+ """Fetch information about settings in a workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.info
"""
kwargs.update({"team_id": team_id})
@@ -1672,6 +1746,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the description of a given workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.setDescription
"""
kwargs.update({"team_id": team_id, "description": description})
@@ -1685,6 +1760,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.setDiscoverability
"""
kwargs.update({"team_id": team_id, "discoverability": discoverability})
@@ -1698,6 +1774,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.setIcon
"""
kwargs.update({"team_id": team_id, "image_url": image_url})
@@ -1711,6 +1788,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the icon of a workspace.
+
https://docs.slack.dev/reference/methods/admin.teams.settings.setName
"""
kwargs.update({"team_id": team_id, "name": name})
@@ -1725,6 +1803,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.addChannels
"""
kwargs.update({"team_id": team_id, "usergroup_id": usergroup_id})
@@ -1743,6 +1822,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Associate one or more default workspaces with an organization-wide IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.addTeams
"""
kwargs.update({"usergroup_id": usergroup_id, "auto_provision": auto_provision})
@@ -1761,6 +1841,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.listChannels
"""
kwargs.update(
@@ -1780,6 +1861,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels
"""
kwargs.update({"usergroup_id": usergroup_id})
@@ -1800,6 +1882,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add an Enterprise user to a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.assign
"""
kwargs.update(
@@ -1832,6 +1915,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Invite a user to a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.invite
"""
kwargs.update(
@@ -1863,7 +1947,8 @@
Classes
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """List users on a workspace
+ """List users on a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.list
"""
kwargs.update(
@@ -1885,6 +1970,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Remove a user from a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.remove
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
@@ -1898,6 +1984,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or owner to be an admin user.
+
https://docs.slack.dev/reference/methods/admin.users.setAdmin
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
@@ -1912,6 +1999,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set an expiration for a guest user.
+
https://docs.slack.dev/reference/methods/admin.users.setExpiration
"""
kwargs.update({"expiration_ts": expiration_ts, "team_id": team_id, "user_id": user_id})
@@ -1925,6 +2013,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or admin user to be a workspace owner.
+
https://docs.slack.dev/reference/methods/admin.users.setOwner
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
@@ -1938,6 +2027,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set an existing guest user, admin user, or owner to be a regular user.
+
https://docs.slack.dev/reference/methods/admin.users.setRegular
"""
kwargs.update({"team_id": team_id, "user_id": user_id})
@@ -1958,7 +2048,8 @@
Classes
source: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Search workflows within the team or enterprise
+ """Search workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.search
"""
if collaborator_ids is not None:
@@ -1988,7 +2079,8 @@
Classes
max_workflow_triggers: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Look up the permissions for a set of workflows
+ """Look up the permissions for a set of workflows.
+
https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup
"""
if isinstance(workflow_ids, (list, tuple)):
@@ -2009,7 +2101,8 @@
Classes
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Add collaborators to workflows within the team or enterprise
+ """Add collaborators to workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add
"""
if isinstance(collaborator_ids, (list, tuple)):
@@ -2029,7 +2122,8 @@
Classes
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Remove collaborators from workflows within the team or enterprise
+ """Remove collaborators from workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove
"""
if isinstance(collaborator_ids, (list, tuple)):
@@ -2048,7 +2142,8 @@
Classes
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Unpublish workflows within the team or enterprise
+ """Unpublish workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.unpublish
"""
if isinstance(workflow_ids, (list, tuple)):
@@ -2066,6 +2161,7 @@
app_token: str,
**kwargs,
) -> SlackResponse:
- """Generate a temporary Socket Mode WebSocket URL that your app can connect to
- in order to receive events and interactive payloads
+ """Generate a temporary Socket Mode WebSocket URL for your app.
+
+ Your app connects to this URL to receive events and interactive payloads.
https://docs.slack.dev/reference/methods/apps.connections.open
"""
kwargs.update({"token": app_token})
@@ -2143,6 +2242,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Get a list of authorizations for the given event context.
+
Each authorization represents an app installation that the event is visible to.
https://docs.slack.dev/reference/methods/apps.event.authorizations.list
"""
@@ -2157,6 +2257,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Uninstalls your app from a workspace.
+
https://docs.slack.dev/reference/methods/apps.uninstall
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret})
@@ -2168,7 +2269,8 @@
Classes
manifest: Union[str, Dict[str, Any]],
**kwargs,
) -> SlackResponse:
- """Create an app from an app manifest
+ """Create an app from an app manifest.
+
https://docs.slack.dev/reference/methods/apps.manifest.create
"""
if isinstance(manifest, str):
@@ -2183,7 +2285,8 @@
Classes
app_id: str,
**kwargs,
) -> SlackResponse:
- """Permanently deletes an app created through app manifests
+ """Permanently deletes an app created through app manifests.
+
https://docs.slack.dev/reference/methods/apps.manifest.delete
"""
kwargs.update({"app_id": app_id})
@@ -2195,7 +2298,8 @@
Classes
app_id: str,
**kwargs,
) -> SlackResponse:
- """Export an app manifest from an existing app
+ """Export an app manifest from an existing app.
+
https://docs.slack.dev/reference/methods/apps.manifest.export
"""
kwargs.update({"app_id": app_id})
@@ -2208,7 +2312,8 @@
Classes
manifest: Union[str, Dict[str, Any]],
**kwargs,
) -> SlackResponse:
- """Update an app from an app manifest
+ """Update an app from an app manifest.
+
https://docs.slack.dev/reference/methods/apps.manifest.update
"""
if isinstance(manifest, str):
@@ -2225,7 +2330,8 @@
Classes
app_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Validate an app manifest
+ """Validate an app manifest.
+
https://docs.slack.dev/reference/methods/apps.manifest.validate
"""
if isinstance(manifest, str):
@@ -2243,6 +2349,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Updates the connection status between a user and an app.
+
https://docs.slack.dev/reference/methods/apps.user.connection.update
"""
kwargs.update({"user_id": user_id, "status": status})
@@ -2254,7 +2361,8 @@
Classes
refresh_token: str,
**kwargs,
) -> SlackResponse:
- """Exchanges a refresh token for a new app configuration token
+ """Exchanges a refresh token for a new app configuration token.
+
https://docs.slack.dev/reference/methods/tooling.tokens.rotate
"""
kwargs.update({"refresh_token": refresh_token})
@@ -2273,6 +2381,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the status for an AI assistant thread.
+
https://docs.slack.dev/reference/methods/assistant.threads.setStatus
"""
kwargs.update(
@@ -2298,6 +2407,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the title for the given assistant thread.
+
https://docs.slack.dev/reference/methods/assistant.threads.setTitle
"""
kwargs.update({"channel_id": channel_id, "thread_ts": thread_ts, "title": title})
@@ -2313,6 +2423,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set suggested prompts for the given assistant thread.
+
https://docs.slack.dev/reference/methods/assistant.threads.setSuggestedPrompts
"""
kwargs.update({"channel_id": channel_id, "prompts": prompts})
@@ -2329,6 +2440,7 @@
**kwargs,
) -> SlackResponse:
"""List the workspaces a token can access.
+
https://docs.slack.dev/reference/methods/auth.teams.list
"""
kwargs.update({"cursor": cursor, "limit": limit, "include_icon": include_icon})
@@ -2365,6 +2479,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Validates an array of blocks, or a message or view payload.
+
Provide exactly one of ``blocks``, ``message``, or ``view``.
https://docs.slack.dev/reference/methods/blocks.validate
"""
@@ -2395,6 +2510,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add bookmark to a channel.
+
https://docs.slack.dev/reference/methods/bookmarks.add
"""
kwargs.update(
@@ -2421,6 +2537,7 @@
thread_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a channel"""
+ """Retrieve a thread of messages posted to a channel."""
kwargs.update({"channel": channel, "thread_ts": thread_ts})
return self.api_call("channels.replies", http_verb="GET", params=kwargs)
@@ -2864,6 +2996,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Appends text to an existing streaming conversation.
+
https://docs.slack.dev/reference/methods/chat.appendStream
"""
kwargs.update(
@@ -2887,6 +3020,7 @@
message_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a permalink URL for a specific extant message
+ """Retrieve a permalink URL for a specific extant message.
+
https://docs.slack.dev/reference/methods/chat.getPermalink
"""
kwargs.update({"channel": channel, "message_ts": message_ts})
@@ -2933,6 +3069,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Share a me message into a channel.
+
https://docs.slack.dev/reference/methods/chat.meMessage
"""
kwargs.update({"channel": channel, "text": text})
@@ -2957,6 +3094,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sends an ephemeral message to a user in a channel.
+
https://docs.slack.dev/reference/methods/chat.postEphemeral
"""
kwargs.update(
@@ -3006,6 +3144,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sends a message to a channel.
+
https://docs.slack.dev/reference/methods/chat.postMessage
"""
kwargs.update(
@@ -3056,6 +3195,7 @@
**kwargs,
) -> SlackResponse:
"""Updates a message in a channel.
+
https://docs.slack.dev/reference/methods/chat.update
"""
kwargs.update(
@@ -3344,6 +3489,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Accepts an invitation to a Slack Connect channel.
+
https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite
"""
if channel_id is None and invite_id is None:
@@ -3368,6 +3514,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Approves an invitation to a Slack Connect channel.
+
https://docs.slack.dev/reference/methods/conversations.approveSharedInvite
"""
kwargs.update({"invite_id": invite_id, "target_team": target_team})
@@ -3380,6 +3527,7 @@
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://docs.slack.dev/reference/methods/conversations.externalInvitePermissions.set
"""
kwargs.update(
@@ -3452,6 +3604,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Fetches a conversation's history of messages and events.
+
https://docs.slack.dev/reference/methods/conversations.history
"""
kwargs.update(
@@ -3476,6 +3629,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Retrieve information about a conversation.
+
https://docs.slack.dev/reference/methods/conversations.info
"""
kwargs.update(
@@ -3496,6 +3650,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Invites users to a channel.
+
https://docs.slack.dev/reference/methods/conversations.invite
"""
kwargs.update(
@@ -3519,6 +3674,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sends an invitation to a Slack Connect channel.
+
https://docs.slack.dev/reference/methods/conversations.inviteShared
"""
if emails is None and user_ids is None:
@@ -3541,6 +3697,7 @@
**kwargs,
) -> SlackResponse:
"""Lists all channels in a Slack team.
+
https://docs.slack.dev/reference/methods/conversations.list
"""
kwargs.update(
@@ -3606,8 +3766,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """List shared channel invites that have been generated
- or received but have not yet been approved by all parties.
+ """List shared channel invites that have been generated or received but have not yet been approved by all parties.
+
https://docs.slack.dev/reference/methods/conversations.listConnectInvites
"""
kwargs.update({"count": count, "cursor": cursor, "team_id": team_id})
@@ -3621,6 +3781,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the read cursor in a channel.
+
https://docs.slack.dev/reference/methods/conversations.mark
"""
kwargs.update({"channel": channel, "ts": ts})
@@ -3635,6 +3796,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Retrieve members of a conversation.
+
https://docs.slack.dev/reference/methods/conversations.members
"""
kwargs.update({"channel": channel, "cursor": cursor, "limit": limit})
@@ -3649,6 +3811,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Opens or resumes a direct message or multi-person direct message.
+
https://docs.slack.dev/reference/methods/conversations.open
"""
if channel is None and users is None:
@@ -3668,6 +3831,7 @@
oldest: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a conversation
+ """Retrieve a thread of messages posted to a conversation.
+
https://docs.slack.dev/reference/methods/conversations.replies
"""
kwargs.update(
@@ -3713,6 +3878,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Approve a request to add an external user to a channel. This also sends them a Slack Connect invite.
+
https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.approve
"""
kwargs.update(
@@ -3734,6 +3900,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Deny a request to invite an external user to a channel.
+
https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.deny
"""
kwargs.update({"invite_id": invite_id, "message": message})
@@ -3752,6 +3919,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists requests to add external users to channels with ability to filter.
+
https://docs.slack.dev/reference/methods/conversations.requestSharedInvite.list
"""
kwargs.update(
@@ -3779,6 +3947,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the purpose for a conversation.
+
https://docs.slack.dev/reference/methods/conversations.setPurpose
"""
kwargs.update({"channel": channel, "purpose": purpose})
@@ -3792,6 +3961,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Sets the topic for a conversation.
+
https://docs.slack.dev/reference/methods/conversations.setTopic
"""
kwargs.update({"channel": channel, "topic": topic})
@@ -3804,6 +3974,7 @@
**kwargs,
) -> SlackResponse:
"""Retrieves a user's current Do Not Disturb status.
+
https://docs.slack.dev/reference/methods/dnd.info
"""
kwargs.update({"team_id": team_id, "user": user})
@@ -3875,6 +4051,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Turns on Do Not Disturb mode for the current user, or changes its duration.
+
https://docs.slack.dev/reference/methods/dnd.setSnooze
"""
kwargs.update({"num_minutes": num_minutes})
@@ -3887,6 +4064,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Retrieves the Do Not Disturb status for users on a team.
+
https://docs.slack.dev/reference/methods/dnd.teamInfo
"""
if isinstance(users, (list, tuple)):
@@ -3902,6 +4080,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists custom emoji for a team.
+
https://docs.slack.dev/reference/methods/emoji.list
"""
kwargs.update({"include_categories": include_categories})
@@ -3917,6 +4096,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Provides entity details for the flexpane.
+
https://docs.slack.dev/reference/methods/entity.presentDetails/
"""
kwargs.update({"trigger_id": trigger_id})
@@ -3939,6 +4119,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Deletes an existing comment on a file.
+
https://docs.slack.dev/reference/methods/files.comments.delete
"""
kwargs.update({"file": file, "id": id})
@@ -3951,6 +4132,7 @@
**kwargs,
) -> SlackResponse:
"""Gets information about a team file.
+
https://docs.slack.dev/reference/methods/files.info
"""
kwargs.update(
@@ -3995,6 +4178,7 @@
**kwargs,
) -> SlackResponse:
"""Share a remote file into a channel.
+
https://docs.slack.dev/reference/methods/files.remote.share
"""
if external_id is None and file is None:
@@ -4169,7 +4359,8 @@
Classes
file: str,
**kwargs,
) -> SlackResponse:
- """Revokes public/external sharing access for a file
+ """Revokes public/external sharing access for a file.
+
https://docs.slack.dev/reference/methods/files.revokePublicURL
"""
kwargs.update({"file": file})
@@ -4182,6 +4373,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Enables a file for public/external sharing.
+
https://docs.slack.dev/reference/methods/files.sharedPublicURL
"""
kwargs.update({"file": file})
@@ -4201,6 +4393,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Uploads or creates a file.
+
https://docs.slack.dev/reference/methods/files.upload
"""
_print_files_upload_v2_suggestion()
@@ -4253,7 +4446,7 @@
Classes
request_file_info: bool = True, # since v3.23, this flag is no longer necessary
**kwargs,
) -> SlackResponse:
- """This wrapper method provides an easy way to upload files using the following endpoints:
+ """Provide an easy way to upload files using the following endpoints.
- step1: https://docs.slack.dev/reference/methods/files.getUploadURLExternal
@@ -4347,6 +4540,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets a URL for an edge external upload.
+
https://docs.slack.dev/reference/methods/files.getUploadURLExternal
"""
kwargs.update(
@@ -4370,6 +4564,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Finishes an upload started with files.getUploadURLExternal.
+
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]
@@ -4392,7 +4587,8 @@
Classes
outputs: Dict[str, Any],
**kwargs,
) -> SlackResponse:
- """Signal the successful completion of a function
+ """Signal the successful completion of a function.
+
https://docs.slack.dev/reference/methods/functions.completeSuccess
"""
kwargs.update({"function_execution_id": function_execution_id, "outputs": json.dumps(outputs)})
@@ -4405,7 +4601,8 @@
Classes
error: str,
**kwargs,
) -> SlackResponse:
- """Signal the failure to execute a function
+ """Signal the failure to execute a function.
+
https://docs.slack.dev/reference/methods/functions.completeError
"""
kwargs.update({"function_execution_id": function_execution_id, "error": error})
@@ -4553,7 +4750,7 @@
Classes
thread_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a private channel"""
+ """Retrieve a thread of messages posted to a private channel."""
kwargs.update({"channel": channel, "thread_ts": thread_ts})
return self.api_call("groups.replies", http_verb="GET", params=kwargs)
@@ -4656,7 +4853,7 @@
Classes
thread_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a direct message conversation"""
+ """Retrieve a thread of messages posted to a direct message conversation."""
kwargs.update({"channel": channel, "thread_ts": thread_ts})
return self.api_call("im.replies", http_verb="GET", params=kwargs)
@@ -4670,7 +4867,8 @@
Classes
to_old: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
- """For Enterprise Grid workspaces, map local user IDs to global user IDs
+ """For Enterprise Grid workspaces, map local user IDs to global user IDs.
+
https://docs.slack.dev/reference/methods/migration.exchange
"""
if isinstance(users, (list, tuple)):
@@ -4746,9 +4944,7 @@
Classes
thread_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a direct message conversation from a
- multiparty direct message.
- """
+ """Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message."""
kwargs.update({"channel": channel, "thread_ts": thread_ts})
return self.api_call("mpim.replies", http_verb="GET", params=kwargs)
@@ -4770,6 +4966,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
+
https://docs.slack.dev/reference/methods/oauth.v2.access
"""
if redirect_uri is not None:
@@ -4796,6 +4993,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token.
+
https://docs.slack.dev/reference/methods/oauth.access
"""
if redirect_uri is not None:
@@ -4815,7 +5013,8 @@
Classes
client_secret: str,
**kwargs,
) -> SlackResponse:
- """Exchanges a legacy access token for a new expiring access token and refresh token
+ """Exchanges a legacy access token for a new expiring access token and refresh token.
+
https://docs.slack.dev/reference/methods/oauth.v2.exchange
"""
kwargs.update({"client_id": client_id, "client_secret": client_secret, "token": token})
@@ -4832,6 +5031,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
+
https://docs.slack.dev/reference/methods/openid.connect.token
"""
if redirect_uri is not None:
@@ -4853,6 +5053,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Get the identity of a user who has authorized Sign in with Slack.
+
https://docs.slack.dev/reference/methods/openid.connect.userInfo
"""
return self.api_call("openid.connect.userInfo", params=kwargs)
@@ -4865,6 +5066,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Pins an item to a channel.
+
https://docs.slack.dev/reference/methods/pins.add
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
@@ -4877,6 +5079,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists items pinned to a channel.
+
https://docs.slack.dev/reference/methods/pins.list
"""
kwargs.update({"channel": channel})
@@ -4890,6 +5093,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Un-pins an item from a channel.
+
https://docs.slack.dev/reference/methods/pins.remove
"""
kwargs.update({"channel": channel, "timestamp": timestamp})
@@ -4904,6 +5108,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Adds a reaction to an item.
+
https://docs.slack.dev/reference/methods/reactions.add
"""
kwargs.update({"channel": channel, "name": name, "timestamp": timestamp})
@@ -4920,6 +5125,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets reactions for an item.
+
https://docs.slack.dev/reference/methods/reactions.get
"""
kwargs.update(
@@ -4946,6 +5152,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists reactions made by a user.
+
https://docs.slack.dev/reference/methods/reactions.list
"""
kwargs.update(
@@ -4972,6 +5179,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Removes a reaction from an item.
+
https://docs.slack.dev/reference/methods/reactions.remove
"""
kwargs.update(
@@ -4996,6 +5204,7 @@
**kwargs,
) -> SlackResponse:
"""Gets information about a reminder.
+
https://docs.slack.dev/reference/methods/reminders.info
"""
kwargs.update({"reminder": reminder, "team_id": team_id})
@@ -5055,6 +5267,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists all reminders created by or for a given user.
+
https://docs.slack.dev/reference/methods/reminders.list
"""
kwargs.update({"team_id": team_id})
@@ -5068,6 +5281,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
+
https://docs.slack.dev/reference/methods/rtm.connect
"""
kwargs.update({"batch_presence_aware": batch_presence_aware, "presence_sub": presence_sub})
@@ -5086,6 +5300,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Starts a Real Time Messaging session.
+
https://docs.slack.dev/reference/methods/rtm.start
"""
kwargs.update(
@@ -5114,6 +5329,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Searches for messages and files matching a query.
+
https://docs.slack.dev/reference/methods/search.all
"""
kwargs.update(
@@ -5142,6 +5358,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Searches for files matching a query.
+
https://docs.slack.dev/reference/methods/search.files
"""
kwargs.update(
@@ -5171,6 +5388,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Searches for messages matching a query.
+
https://docs.slack.dev/reference/methods/search.messages
"""
kwargs.update(
@@ -5196,6 +5414,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Revoke access to a List for specified entities.
+
https://docs.slack.dev/reference/methods/slackLists.access.delete
"""
kwargs.update({"list_id": list_id, "channel_ids": channel_ids, "user_ids": user_ids})
@@ -5212,6 +5431,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set the access level to a List for specified entities.
+
https://docs.slack.dev/reference/methods/slackLists.access.set
"""
kwargs.update({"list_id": list_id, "access_level": access_level, "channel_ids": channel_ids, "user_ids": user_ids})
@@ -5230,6 +5450,7 @@
**kwargs,
) -> SlackResponse:
"""Retrieve List download URL from an export job to download List contents.
+
https://docs.slack.dev/reference/methods/slackLists.download.get
"""
kwargs.update(
@@ -5272,6 +5494,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Initiate a job to export List contents.
+
https://docs.slack.dev/reference/methods/slackLists.download.start
"""
kwargs.update(
@@ -5293,6 +5516,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add a new item to an existing List.
+
https://docs.slack.dev/reference/methods/slackLists.items.create
"""
kwargs.update(
@@ -5314,6 +5538,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Deletes an item from an existing List.
+
https://docs.slack.dev/reference/methods/slackLists.items.delete
"""
kwargs.update(
@@ -5333,6 +5558,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Deletes multiple items from an existing List.
+
https://docs.slack.dev/reference/methods/slackLists.items.deleteMultiple
"""
kwargs.update(
@@ -5353,6 +5579,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Get a row from a List.
+
https://docs.slack.dev/reference/methods/slackLists.items.info
"""
kwargs.update(
@@ -5375,6 +5602,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Get records from a List.
+
https://docs.slack.dev/reference/methods/slackLists.items.list
"""
kwargs.update(
@@ -5396,6 +5624,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Updates cells in a List.
+
https://docs.slack.dev/reference/methods/slackLists.items.update
"""
kwargs.update(
@@ -5417,6 +5646,7 @@
**kwargs,
) -> SlackResponse:
"""Adds a star to an item.
+
https://docs.slack.dev/reference/methods/stars.add
"""
kwargs.update(
@@ -5463,6 +5694,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists stars for a user.
+
https://docs.slack.dev/reference/methods/stars.list
"""
kwargs.update(
@@ -5486,6 +5718,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Removes a star from an item.
+
https://docs.slack.dev/reference/methods/stars.remove
"""
kwargs.update(
@@ -5510,6 +5743,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets the access logs for the current team.
+
https://docs.slack.dev/reference/methods/team.accessLogs
"""
kwargs.update(
@@ -5532,6 +5766,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets billable users information for the current team.
+
https://docs.slack.dev/reference/methods/team.billableInfo
"""
kwargs.update({"team_id": team_id, "user": user})
@@ -5542,6 +5777,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Reads a workspace's billing plan information.
+
https://docs.slack.dev/reference/methods/team.billing.info
"""
return self.api_call("team.billing.info", params=kwargs)
@@ -5553,6 +5789,7 @@
**kwargs,
) -> SlackResponse:
"""Returns a list of all the external teams connected and details about the connection.
+
https://docs.slack.dev/reference/methods/team.externalTeams.list
"""
kwargs.update(
@@ -5606,6 +5844,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets information about the current team.
+
https://docs.slack.dev/reference/methods/team.info
"""
kwargs.update({"team": team, "domain": domain})
@@ -5624,6 +5863,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Gets the integration logs for the current team.
+
https://docs.slack.dev/reference/methods/team.integrationLogs
"""
kwargs.update(
@@ -5646,6 +5886,7 @@
**kwargs,
) -> SlackResponse:
"""Retrieve a list of a workspace's team preferences.
+
https://docs.slack.dev/reference/methods/team.preferences.list
"""
return self.api_call("team.preferences.list", params=kwargs)
@@ -5671,7 +5913,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Create a User Group
+ """Create a User Group.
+
https://docs.slack.dev/reference/methods/usergroups.create
"""
kwargs.update(
@@ -5697,7 +5940,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Disable an existing User Group
+ """Disable an existing User Group.
+
https://docs.slack.dev/reference/methods/usergroups.disable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
@@ -5711,7 +5955,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Enable a User Group
+ """Enable a User Group.
+
https://docs.slack.dev/reference/methods/usergroups.enable
"""
kwargs.update({"usergroup": usergroup, "include_count": include_count, "team_id": team_id})
@@ -5726,7 +5971,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """List all User Groups for a team
+ """List all User Groups for a team.
+
https://docs.slack.dev/reference/methods/usergroups.list
"""
kwargs.update(
@@ -5751,7 +5997,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Update an existing User Group
+ """Update an existing User Group.
+
https://docs.slack.dev/reference/methods/usergroups.update
"""
kwargs.update(
@@ -5778,7 +6025,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """List all users in a User Group
+ """List all users in a User Group.
+
https://docs.slack.dev/reference/methods/usergroups.users.list
"""
kwargs.update(
@@ -5799,7 +6047,8 @@
Classes
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Update the list of users for a User Group
+ """Update the list of users for a User Group.
+
https://docs.slack.dev/reference/methods/usergroups.users.update
"""
kwargs.update(
@@ -5827,6 +6076,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List conversations the calling user may access.
+
https://docs.slack.dev/reference/methods/users.conversations
"""
kwargs.update(
@@ -5848,7 +6098,8 @@
Classes
self,
**kwargs,
) -> SlackResponse:
- """Delete the user profile photo
+ """Delete the user profile photo.
+
https://docs.slack.dev/reference/methods/users.deletePhoto
"""
return self.api_call("users.deletePhoto", http_verb="GET", params=kwargs)
@@ -5860,6 +6111,7 @@
**kwargs,
) -> SlackResponse:
"""Gets information about a user.
+
https://docs.slack.dev/reference/methods/users.info
"""
kwargs.update({"user": user, "include_locale": include_locale})
@@ -5897,6 +6151,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Lists all users in a Slack team.
+
https://docs.slack.dev/reference/methods/users.list
"""
kwargs.update(
@@ -5916,6 +6171,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Find a user with an email address.
+
https://docs.slack.dev/reference/methods/users.lookupByEmail
"""
kwargs.update({"email": email})
@@ -5930,7 +6186,8 @@
Classes
crop_y: Optional[Union[int, str]] = None,
**kwargs,
) -> SlackResponse:
- """Set the user profile photo
+ """Set the user profile photo.
+
https://docs.slack.dev/reference/methods/users.setPhoto
"""
kwargs.update({"crop_w": crop_w, "crop_x": crop_x, "crop_y": crop_y})
@@ -5943,6 +6200,7 @@
email: str,
**kwargs,
) -> SlackResponse:
- """Lookup an email address to see if someone is on Slack
+ """Lookup an email address to see if someone is on Slack.
+
https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup
"""
kwargs.update({"email": email})
@@ -5967,6 +6226,7 @@
**kwargs,
) -> SlackResponse:
"""Set the profile information for a user.
+
https://docs.slack.dev/reference/methods/users.profile.set
"""
kwargs.update(
@@ -6005,6 +6266,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Open a view for a user.
+
https://docs.slack.dev/reference/methods/views.open
See https://docs.slack.dev/surfaces/modals/ for details.
"""
@@ -6026,6 +6288,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Push a view onto the stack of a root view.
+
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.
@@ -6052,6 +6315,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""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://docs.slack.dev/surfaces/modals/#updating_views)
@@ -6082,6 +6346,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Publish a static view for a User.
+
Create or update the view that comprises an
app's Home tab (https://docs.slack.dev/surfaces/app-home/)
https://docs.slack.dev/reference/methods/views.publish
@@ -6103,6 +6368,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Add featured workflows to a channel.
+
https://docs.slack.dev/reference/methods/workflows.featured.add
"""
kwargs.update({"channel_id": channel_id})
@@ -6119,6 +6385,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""List the featured workflows for specified channels.
+
https://docs.slack.dev/reference/methods/workflows.featured.list
"""
if isinstance(channel_ids, (list, tuple)):
@@ -6135,6 +6402,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Remove featured workflows from a channel.
+
https://docs.slack.dev/reference/methods/workflows.featured.remove
"""
kwargs.update({"channel_id": channel_id})
@@ -6152,6 +6420,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Set featured workflows for a channel.
+
https://docs.slack.dev/reference/methods/workflows.featured.set
"""
kwargs.update({"channel_id": channel_id})
@@ -6169,6 +6438,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Indicate a successful outcome of a workflow step's execution.
+
https://docs.slack.dev/reference/methods/workflows.stepCompleted
"""
kwargs.update({"workflow_step_execute_id": workflow_step_execute_id})
@@ -6186,6 +6456,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Indicate an unsuccessful outcome of a workflow step's execution.
+
https://docs.slack.dev/reference/methods/workflows.stepFailed
"""
kwargs.update(
@@ -6207,6 +6478,7 @@
Classes
**kwargs,
) -> SlackResponse:
"""Update the configuration for a workflow extension step.
+
https://docs.slack.dev/reference/methods/workflows.updateStep
"""
kwargs.update({"workflow_step_edit_id": workflow_step_edit_id})
@@ -6301,7 +6573,8 @@
Methods
metadata_only: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
- """Retrieve analytics data for a given date, presented as a compressed JSON file
+ """Retrieve analytics data for a given date, presented as a compressed JSON file.
+
https://docs.slack.dev/reference/methods/admin.analytics.getFile
"""
kwargs.update({"type": type})
@@ -6311,8 +6584,8 @@
**kwargs,
) -> SlackResponse:
"""Approve an app for installation on a workspace.
+
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.
@@ -6403,8 +6678,8 @@
app_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Look up the app config for connectors by their IDs
+ """Look up the app config for connectors by their IDs.
+
https://docs.slack.dev/reference/methods/admin.apps.config.lookup
"""
if isinstance(app_ids, (list, tuple)):
@@ -6496,8 +6774,8 @@
**kwargs,
) -> SlackResponse:
"""Restrict an app for installation on a workspace.
+
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.
@@ -6631,8 +6913,8 @@
Restrict an app for installation on a workspace.
-Exactly one of the team_id or enterprise_id arguments is required, not both.
+
Restrict an app for installation on a workspace.
+
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://docs.slack.dev/reference/methods/admin.apps.restrict
@@ -6655,6 +6937,7 @@
Methods
**kwargs,
) -> SlackResponse:
"""List restricted apps for an org or workspace.
+
https://docs.slack.dev/reference/methods/admin.apps.restricted.list
"""
kwargs.update(
@@ -6667,8 +6950,8 @@
**kwargs,
) -> 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://docs.slack.dev/reference/methods/admin.apps.uninstall
"""
@@ -6700,8 +6984,8 @@
**kwargs,
) -> SlackResponse:
"""Fetch all the entities assigned to a particular authentication policy by name.
+
https://docs.slack.dev/reference/methods/admin.auth.policy.getEntities
"""
kwargs.update({"policy_name": policy_name})
@@ -6763,8 +7049,8 @@
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Get all Information Barriers for your organization
- https://docs.slack.dev/reference/methods/admin.barriers.list"""
+ """Get all Information Barriers for your organization.
+
+ https://docs.slack.dev/reference/methods/admin.barriers.list
+ """
kwargs.update(
{
"cursor": cursor,
@@ -6877,8 +7168,8 @@
**kwargs,
) -> SlackResponse:
"""Disconnect a connected channel from one or more workspaces.
+
https://docs.slack.dev/reference/methods/admin.conversations.disconnectShared
"""
kwargs.update({"channel_id": channel_id})
@@ -7168,8 +7470,8 @@
team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
- """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.
+ """List all disconnected channels and the corresponding original channel IDs for key revocation with EKM.
+
+ Disconnected channels are those that were once connected to other workspaces and then disconnected.
https://docs.slack.dev/reference/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
"""
kwargs.update(
@@ -7209,9 +7511,8 @@
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.
+
List all disconnected channels and the corresponding original channel IDs for key revocation with EKM.
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.getTeams
"""
kwargs.update(
@@ -7288,8 +7592,8 @@
**kwargs,
) -> SlackResponse:
"""Invite a user to a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.invite
"""
kwargs.update({"channel_id": channel_id})
@@ -7317,8 +7622,8 @@
Methods
# NOTE: the endpoint is unable to handle Content-Type: application/json as of Sep 3, 2020.
return self.api_call("admin.conversations.invite", params=kwargs)
-
**kwargs,
) -> SlackResponse:
"""Link a Salesforce record to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.linkObjects
"""
kwargs.update(
@@ -7348,8 +7654,8 @@
**kwargs,
) -> SlackResponse:
"""Returns channels on the given team using the filters.
+
https://docs.slack.dev/reference/methods/admin.conversations.lookup
"""
kwargs.update(
@@ -7386,8 +7693,8 @@
**kwargs,
) -> SlackResponse:
"""Add an allowlist of IDP groups for accessing a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.addGroup
"""
kwargs.update(
@@ -7468,8 +7778,8 @@
**kwargs,
) -> SlackResponse:
"""List all IDP Groups linked to a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.restrictAccess.listGroups
"""
kwargs.update(
@@ -7501,8 +7812,8 @@
**kwargs,
) -> SlackResponse:
"""Search for public or private channels in an Enterprise organization.
+
https://docs.slack.dev/reference/methods/admin.conversations.search
"""
kwargs.update(
@@ -7584,8 +7897,8 @@
**kwargs,
) -> SlackResponse:
"""Set the posting permissions for a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.setConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
@@ -7612,8 +7926,8 @@
**kwargs,
) -> SlackResponse:
"""Set the workspaces in an Enterprise grid org that connect to a public or private channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.setTeams
"""
kwargs.update(
@@ -7672,8 +7988,8 @@
**kwargs,
) -> SlackResponse:
"""Unlink a Salesforce record from a channel.
+
https://docs.slack.dev/reference/methods/admin.conversations.unlinkObjects
"""
kwargs.update(
@@ -7724,8 +8042,8 @@
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Look up functions by a set of apps
+ """Look up functions by a set of apps.
+
https://docs.slack.dev/reference/methods/admin.functions.list
"""
if isinstance(app_ids, (list, tuple)):
@@ -7879,8 +8203,8 @@
function_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Lookup the visibility of multiple Slack functions
- and include the users if it is limited to particular named entities.
+ """Lookup the visibility of multiple Slack functions.
+
+ Include the users if the visibility is limited to particular named entities.
https://docs.slack.dev/reference/methods/admin.functions.permissions.lookup
"""
if isinstance(function_ids, (list, tuple)):
@@ -7906,8 +8231,8 @@
user_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
- """Set the visibility of a Slack function
- and define the users or workspaces if it is set to named_entities
+ """Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities.
+
https://docs.slack.dev/reference/methods/admin.functions.permissions.set
"""
kwargs.update(
@@ -7943,9 +8268,8 @@
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Adds members to the specified role with the specified scopes
+ """Adds members to the specified role with the specified scopes.
+
https://docs.slack.dev/reference/methods/admin.roles.addAssignments
"""
kwargs.update({"role_id": role_id})
@@ -8104,8 +8433,8 @@
**kwargs,
) -> SlackResponse:
"""Lists assignments for all roles across entities.
+
Options to scope results by any combination of roles or entities
https://docs.slack.dev/reference/methods/admin.roles.listAssignments
"""
@@ -8140,9 +8470,10 @@
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Removes a set of users from a role for the given scopes and entities
+ """Removes a set of users from a role for the given scopes and entities.
+
https://docs.slack.dev/reference/methods/admin.roles.removeAssignments
"""
kwargs.update({"role_id": role_id})
@@ -8174,8 +8506,8 @@
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
+
https://docs.slack.dev/reference/methods/admin.inviteRequests.list
"""
kwargs.update(
@@ -8205,8 +8538,8 @@
**kwargs,
) -> SlackResponse:
"""List all of the admins on a given workspace.
+
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)
-
team_id: str,
**kwargs,
) -> SlackResponse:
- """Fetch information about settings in a workspace
+ """Fetch information about settings in a workspace.
+
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)
-
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.addChannels
"""
kwargs.update({"team_id": team_id, "usergroup_id": usergroup_id})
@@ -8463,8 +8806,8 @@
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.listChannels
"""
kwargs.update(
@@ -8523,8 +8868,8 @@
**kwargs,
) -> SlackResponse:
"""Add one or more default channels to an IDP group.
+
https://docs.slack.dev/reference/methods/admin.usergroups.removeChannels
"""
kwargs.update({"usergroup_id": usergroup_id})
@@ -8551,8 +8897,8 @@
**kwargs,
) -> SlackResponse:
"""Add an Enterprise user to a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.assign
"""
kwargs.update(
@@ -8589,8 +8936,8 @@
**kwargs,
) -> SlackResponse:
"""Invite a user to a workspace.
+
https://docs.slack.dev/reference/methods/admin.users.invite
"""
kwargs.update(
@@ -8637,8 +8985,8 @@
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Clear user-specific session settings—the session duration
- and what happens when the client closes—for a list of users.
+ """Clear user-specific session settings for a list of users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.clearSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -8723,8 +9074,8 @@
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Get user-specific session settings—the session duration
- and what happens when the client closes—given a list of users.
+ """Get user-specific session settings for a given list of users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.getSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -8751,8 +9103,8 @@
**kwargs,
) -> SlackResponse:
"""Invalidate a single session for a user by session_id.
+
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)
-
user_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Lists all active user sessions for an organization
+ """Lists all active user sessions for an organization.
+
https://docs.slack.dev/reference/methods/admin.users.session.list
"""
kwargs.update(
@@ -8809,8 +9163,8 @@
**kwargs,
) -> SlackResponse:
"""Wipes all valid sessions on all devices for a given user.
+
https://docs.slack.dev/reference/methods/admin.users.session.reset
"""
kwargs.update(
@@ -8840,8 +9195,8 @@
web_only: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
- """Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users
+ """Enqueues an asynchronous job to wipe all valid sessions on all devices for a given list of users.
+
https://docs.slack.dev/reference/methods/admin.users.session.resetBulk
"""
if isinstance(user_ids, (list, tuple)):
@@ -8874,8 +9230,8 @@
duration: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Configure the user-level session settings—the session duration
- and what happens when the client closes—for one or more users.
+ """Configure the user-level session settings for one or more users.
+
+ The settings include the session duration and what happens when the client closes.
https://docs.slack.dev/reference/methods/admin.users.session.setSettings
"""
if isinstance(user_ids, (list, tuple)):
@@ -8909,8 +9266,8 @@
**kwargs,
) -> SlackResponse:
"""Set an existing guest, regular user, or admin user to be a workspace owner.
+
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)
-
date_sessions_started: Optional[Union[str, int]] = None,
**kwargs,
) -> SlackResponse:
- """Ask Slackbot to send you an export listing all workspace members using unsupported software,
- presented as a zipped CSV file.
+ """Ask Slackbot to send you an export listing all workspace members using unsupported software.
+
+ The export is presented as a zipped CSV file.
https://docs.slack.dev/reference/methods/admin.users.unsupportedVersions.export
"""
kwargs.update(
@@ -9037,8 +9399,8 @@
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Add collaborators to workflows within the team or enterprise
+ """Add collaborators to workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.collaborators.add
"""
if isinstance(collaborator_ids, (list, tuple)):
@@ -9069,8 +9432,8 @@
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Remove collaborators from workflows within the team or enterprise
+ """Remove collaborators from workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.collaborators.remove
"""
if isinstance(collaborator_ids, (list, tuple)):
@@ -9100,8 +9464,8 @@
max_workflow_triggers: Optional[int] = None,
**kwargs,
) -> SlackResponse:
- """Look up the permissions for a set of workflows
+ """Look up the permissions for a set of workflows.
+
https://docs.slack.dev/reference/methods/admin.workflows.permissions.lookup
"""
if isinstance(workflow_ids, (list, tuple)):
@@ -9132,8 +9497,8 @@
source: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Search workflows within the team or enterprise
+ """Search workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.search
"""
if collaborator_ids is not None:
@@ -9181,8 +9547,8 @@
workflow_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
- """Unpublish workflows within the team or enterprise
+ """Unpublish workflows within the team or enterprise.
+
https://docs.slack.dev/reference/methods/admin.workflows.unpublish
"""
if isinstance(workflow_ids, (list, tuple)):
@@ -9207,8 +9574,8 @@
app_token: str,
**kwargs,
) -> SlackResponse:
- """Generate a temporary Socket Mode WebSocket URL that your app can connect to
- in order to receive events and interactive payloads
+ """Generate a temporary Socket Mode WebSocket URL for your app.
+
+ Your app connects to this URL to receive events and interactive payloads.
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
+
Generate a temporary Socket Mode WebSocket URL for your app.
**kwargs,
) -> SlackResponse:
"""Get a list of authorizations for the given event context.
+
Each authorization represents an app installation that the event is visible to.
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.
+
Get a list of authorizations for the given event context.
manifest: Union[str, Dict[str, Any]],
**kwargs,
) -> SlackResponse:
- """Create an app from an app manifest
+ """Create an app from an app manifest.
+
https://docs.slack.dev/reference/methods/apps.manifest.create
"""
if isinstance(manifest, str):
@@ -9382,8 +9755,8 @@
manifest: Union[str, Dict[str, Any]],
**kwargs,
) -> SlackResponse:
- """Update an app from an app manifest
+ """Update an app from an app manifest.
+
https://docs.slack.dev/reference/methods/apps.manifest.update
"""
if isinstance(manifest, str):
@@ -9456,8 +9832,8 @@
**kwargs,
) -> SlackResponse:
"""Updates the connection status between a user and an app.
+
https://docs.slack.dev/reference/methods/apps.user.connection.update
"""
kwargs.update({"user_id": user_id, "status": status})
return self.api_call("apps.user.connection.update", params=kwargs)
-
**kwargs,
) -> SlackResponse:
"""Set the status for an AI assistant thread.
+
https://docs.slack.dev/reference/methods/assistant.threads.setStatus
"""
kwargs.update(
@@ -9572,8 +9952,8 @@
**kwargs,
) -> SlackResponse:
"""Set the title for the given assistant thread.
+
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)
-
**kwargs,
) -> SlackResponse:
"""Validates an array of blocks, or a message or view payload.
+
Provide exactly one of ``blocks``, ``message``, or ``view``.
https://docs.slack.dev/reference/methods/blocks.validate
"""
@@ -9731,8 +10117,8 @@
thread_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a channel"""
+ """Retrieve a thread of messages posted to a channel."""
kwargs.update({"channel": channel, "thread_ts": thread_ts})
return self.api_call("channels.replies", http_verb="GET", params=kwargs)
-
Retrieve a thread of messages posted to a channel
+
Retrieve a thread of messages posted to a channel.
message_ts: str,
**kwargs,
) -> SlackResponse:
- """Retrieve a permalink URL for a specific extant message
+ """Retrieve a permalink URL for a specific extant message.
+
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)
-
**kwargs,
) -> SlackResponse:
"""Sends an ephemeral message to a user in a channel.
+
https://docs.slack.dev/reference/methods/chat.postEphemeral
"""
kwargs.update(
@@ -10727,8 +11136,8 @@
Methods
# NOTE: intentionally using json over params for the API methods using blocks/attachments
return self.api_call("chat.postEphemeral", json=kwargs)
-
**kwargs,
) -> SlackResponse:
"""Accepts an invitation to a Slack Connect channel.
+
https://docs.slack.dev/reference/methods/conversations.acceptSharedInvite
"""
if channel_id is None and invite_id is None:
@@ -11258,8 +11675,8 @@
**kwargs,
) -> SlackResponse:
"""Fetches a conversation's history of messages and events.
+
https://docs.slack.dev/reference/methods/conversations.history
"""
kwargs.update(
@@ -11466,8 +11891,8 @@
**kwargs,
) -> SlackResponse:
"""Sends an invitation to a Slack Connect channel.
+
https://docs.slack.dev/reference/methods/conversations.inviteShared
"""
if emails is None and user_ids is None:
@@ -11566,8 +11994,8 @@
**kwargs,
) -> SlackResponse:
"""Lists all channels in a Slack team.
+
https://docs.slack.dev/reference/methods/conversations.list
"""
kwargs.update(
@@ -11674,8 +12106,8 @@
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """List shared channel invites that have been generated
- or received but have not yet been approved by all parties.
+ """List shared channel invites that have been generated or received but have not yet been approved by all parties.
+
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)
-
**kwargs,
) -> SlackResponse:
"""Opens or resumes a direct message or multi-person direct message.
+
https://docs.slack.dev/reference/methods/conversations.open
"""
if channel is None and users is None:
@@ -11781,8 +12215,8 @@
oldest: Optional[str] = None,
**kwargs,
) -> SlackResponse:
- """Retrieve a thread of messages posted to a conversation
+ """Retrieve a thread of messages posted to a conversation.
+
https://docs.slack.dev/reference/methods/conversations.replies
"""
kwargs.update(
@@ -11846,8 +12282,8 @@