@@ -209,17 +209,28 @@ <h2 class="section-title" id="header-classes">Classes</h2>
209209<h2 id="attributes">Attributes</h2>
210210<dl>
211211<dt><strong><code>token</code></strong> : <code>str</code></dt>
212- <dd>A string specifying an xoxp or xoxb token.</dd>
212+ <dd>A string specifying an <code> xoxp-*</code> or <code> xoxb-*</code> token.</dd>
213213<dt><strong><code>base_url</code></strong> : <code>str</code></dt>
214214<dd>A string representing the Slack API base URL.
215- Default is 'https://www.slack.com/api/'</dd>
215+ Default is <code> 'https://www.slack.com/api/'</code> </dd>
216216<dt><strong><code>timeout</code></strong> : <code>int</code></dt>
217217<dd>The maximum number of seconds the client will wait
218218to connect and receive a response from Slack.
219219Default is 30 seconds.</dd>
220+ <dt><strong><code>ssl</code></strong> : <code>SSLContext</code></dt>
221+ <dd>An <a href="https://docs.python.org/3/library/ssl.html#ssl.SSLContext"><code>ssl.SSLContext</code></a> instance, helpful for specifying
222+ your own custom certificate chain.</dd>
223+ <dt><strong><code>proxy</code></strong> : <code>str</code></dt>
224+ <dd>String representing a fully-qualified URL to a proxy through
225+ which to route all requests to the Slack API. Even if this parameter
226+ is not specified, if any of the following environment variables are
227+ present, they will be loaded into this parameter: <code>HTTPS_PROXY</code>,
228+ <code>https_proxy</code>, <code>HTTP_PROXY</code> or <code>http_proxy</code>.</dd>
229+ <dt><strong><code>headers</code></strong> : <code>dict</code></dt>
230+ <dd>Additional request headers to attach to all requests.</dd>
220231</dl>
221232<h2 id="methods">Methods</h2>
222- <p>api_call: Constructs a request and executes the API call to Slack.</p>
233+ <p><code> api_call</code> : Constructs a request and executes the API call to Slack.</p>
223234<p>Example of recommended usage:</p>
224235<pre><code class="language-python"> import os
225236 from slack_sdk import WebClient
@@ -263,15 +274,23 @@ <h2 id="note">Note</h2>
263274 as well as parsing any responses received into a `SlackResponse`.
264275
265276 Attributes:
266- token (str): A string specifying an xoxp or xoxb token.
277+ token (str): A string specifying an ` xoxp-*` or ` xoxb-*` token.
267278 base_url (str): A string representing the Slack API base URL.
268- Default is 'https://www.slack.com/api/'
279+ Default is ` 'https://www.slack.com/api/'`
269280 timeout (int): The maximum number of seconds the client will wait
270281 to connect and receive a response from Slack.
271282 Default is 30 seconds.
283+ ssl (SSLContext): An [`ssl.SSLContext`][1] instance, helpful for specifying
284+ your own custom certificate chain.
285+ proxy (str): String representing a fully-qualified URL to a proxy through
286+ which to route all requests to the Slack API. Even if this parameter
287+ is not specified, if any of the following environment variables are
288+ present, they will be loaded into this parameter: `HTTPS_PROXY`,
289+ `https_proxy`, `HTTP_PROXY` or `http_proxy`.
290+ headers (dict): Additional request headers to attach to all requests.
272291
273292 Methods:
274- api_call: Constructs a request and executes the API call to Slack.
293+ ` api_call` : Constructs a request and executes the API call to Slack.
275294
276295 Example of recommended usage:
277296 ```python
@@ -304,6 +323,8 @@ <h2 id="note">Note</h2>
304323 Any attributes or methods prefixed with _underscores are
305324 intended to be "private" internal use only. They may be changed or
306325 removed at anytime.
326+
327+ [1]: https://docs.python.org/3/library/ssl.html#ssl.SSLContext
307328 """
308329
309330 def admin_analytics_getFile(
@@ -1786,6 +1807,19 @@ <h2 id="note">Note</h2>
17861807 """
17871808 return self.api_call("auth.test", params=kwargs)
17881809
1810+ def auth_teams_list(
1811+ self,
1812+ cursor: Optional[str] = None,
1813+ limit: Optional[int] = None,
1814+ include_icon: Optional[bool] = None,
1815+ **kwargs,
1816+ ) -> SlackResponse:
1817+ """List the workspaces a token can access.
1818+ https://api.slack.com/methods/auth.teams.list
1819+ """
1820+ kwargs.update({"cursor": cursor, "limit": limit, "include_icon": include_icon})
1821+ return self.api_call("auth.teams.list", params=kwargs)
1822+
17891823 def bookmarks_add(
17901824 self,
17911825 *,
@@ -7058,6 +7092,30 @@ <h3>Methods</h3>
70587092 return self.api_call("auth.revoke", http_verb="GET", params=kwargs)</code></pre>
70597093</details>
70607094</dd>
7095+ <dt id="slack_sdk.WebClient.auth_teams_list"><code class="name flex">
7096+ <span>def <span class="ident">auth_teams_list</span></span>(<span>self, cursor: Optional[str] = None, limit: Optional[int] = None, include_icon: Optional[bool] = None, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
7097+ </code></dt>
7098+ <dd>
7099+ <div class="desc"><p>List the workspaces a token can access.
7100+ <a href="https://api.slack.com/methods/auth.teams.list">https://api.slack.com/methods/auth.teams.list</a></p></div>
7101+ <details class="source">
7102+ <summary>
7103+ <span>Expand source code</span>
7104+ </summary>
7105+ <pre><code class="python">def auth_teams_list(
7106+ self,
7107+ cursor: Optional[str] = None,
7108+ limit: Optional[int] = None,
7109+ include_icon: Optional[bool] = None,
7110+ **kwargs,
7111+ ) -> SlackResponse:
7112+ """List the workspaces a token can access.
7113+ https://api.slack.com/methods/auth.teams.list
7114+ """
7115+ kwargs.update({"cursor": cursor, "limit": limit, "include_icon": include_icon})
7116+ return self.api_call("auth.teams.list", params=kwargs)</code></pre>
7117+ </details>
7118+ </dd>
70617119<dt id="slack_sdk.WebClient.auth_test"><code class="name flex">
70627120<span>def <span class="ident">auth_test</span></span>(<span>self, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
70637121</code></dt>
@@ -11730,6 +11788,12 @@ <h3>Inherited members</h3>
1173011788<li><code><b><a title="slack_sdk.web.base_client.BaseClient" href="web/base_client.html#slack_sdk.web.base_client.BaseClient">BaseClient</a></b></code>:
1173111789<ul class="hlist">
1173211790<li><code><a title="slack_sdk.web.base_client.BaseClient.api_call" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.api_call">api_call</a></code></li>
11791+ <li><code><a title="slack_sdk.web.base_client.BaseClient.base_url" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.base_url">base_url</a></code></li>
11792+ <li><code><a title="slack_sdk.web.base_client.BaseClient.headers" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.headers">headers</a></code></li>
11793+ <li><code><a title="slack_sdk.web.base_client.BaseClient.proxy" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.proxy">proxy</a></code></li>
11794+ <li><code><a title="slack_sdk.web.base_client.BaseClient.ssl" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.ssl">ssl</a></code></li>
11795+ <li><code><a title="slack_sdk.web.base_client.BaseClient.timeout" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.timeout">timeout</a></code></li>
11796+ <li><code><a title="slack_sdk.web.base_client.BaseClient.token" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.token">token</a></code></li>
1173311797<li><code><a title="slack_sdk.web.base_client.BaseClient.validate_slack_signature" href="web/base_client.html#slack_sdk.web.base_client.BaseClient.validate_slack_signature">validate_slack_signature</a></code></li>
1173411798</ul>
1173511799</li>
@@ -12319,6 +12383,7 @@ <h4><code><a title="slack_sdk.WebClient" href="#slack_sdk.WebClient">WebClient</
1231912383<li><code><a title="slack_sdk.WebClient.apps_event_authorizations_list" href="#slack_sdk.WebClient.apps_event_authorizations_list">apps_event_authorizations_list</a></code></li>
1232012384<li><code><a title="slack_sdk.WebClient.apps_uninstall" href="#slack_sdk.WebClient.apps_uninstall">apps_uninstall</a></code></li>
1232112385<li><code><a title="slack_sdk.WebClient.auth_revoke" href="#slack_sdk.WebClient.auth_revoke">auth_revoke</a></code></li>
12386+ <li><code><a title="slack_sdk.WebClient.auth_teams_list" href="#slack_sdk.WebClient.auth_teams_list">auth_teams_list</a></code></li>
1232212387<li><code><a title="slack_sdk.WebClient.auth_test" href="#slack_sdk.WebClient.auth_test">auth_test</a></code></li>
1232312388<li><code><a title="slack_sdk.WebClient.bookmarks_add" href="#slack_sdk.WebClient.bookmarks_add">bookmarks_add</a></code></li>
1232412389<li><code><a title="slack_sdk.WebClient.bookmarks_edit" href="#slack_sdk.WebClient.bookmarks_edit">bookmarks_edit</a></code></li>
0 commit comments