Skip to content

Commit fc9b73a

Browse files
committed
docs(web-client): generate docs
1 parent c8dd10b commit fc9b73a

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

docs/reference/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3004,7 +3004,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
30043004
self,
30053005
*,
30063006
channel: str,
3007-
thread_ts: Optional[str] = None,
3007+
thread_ts: str,
30083008
markdown_text: Optional[str] = None,
30093009
recipient_team_id: Optional[str] = None,
30103010
recipient_user_id: Optional[str] = None,
@@ -10268,7 +10268,7 @@ <h3>Methods</h3>
1026810268
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
1026910269
</dd>
1027010270
<dt id="slack_sdk.WebClient.chat_startStream"><code class="name flex">
10271-
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
10271+
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
1027210272
</code></dt>
1027310273
<dd>
1027410274
<details class="source">
@@ -10279,7 +10279,7 @@ <h3>Methods</h3>
1027910279
self,
1028010280
*,
1028110281
channel: str,
10282-
thread_ts: Optional[str] = None,
10282+
thread_ts: str,
1028310283
markdown_text: Optional[str] = None,
1028410284
recipient_team_id: Optional[str] = None,
1028510285
recipient_user_id: Optional[str] = None,

docs/reference/oauth/installation_store/file/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
4848
<dl>
4949
<dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class">
5050
<span>class <span class="ident">FileInstallationStore</span></span>
51-
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
51+
<span>(</span><span>*,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
5252
</code></dt>
5353
<dd>
5454
<details class="source">

docs/reference/oauth/installation_store/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ <h3>Methods</h3>
327327
</dd>
328328
<dt id="slack_sdk.oauth.installation_store.FileInstallationStore"><code class="flex name class">
329329
<span>class <span class="ident">FileInstallationStore</span></span>
330-
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
330+
<span>(</span><span>*,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
331331
</code></dt>
332332
<dd>
333333
<details class="source">

docs/reference/oauth/state_store/file/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
4848
<dl>
4949
<dt id="slack_sdk.oauth.state_store.file.FileOAuthStateStore"><code class="flex name class">
5050
<span>class <span class="ident">FileOAuthStateStore</span></span>
51-
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
51+
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
5252
</code></dt>
5353
<dd>
5454
<details class="source">

docs/reference/oauth/state_store/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
7777
<dl>
7878
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
7979
<span>class <span class="ident">FileOAuthStateStore</span></span>
80-
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
80+
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
8181
</code></dt>
8282
<dd>
8383
<details class="source">

docs/reference/web/async_client.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2900,7 +2900,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
29002900
self,
29012901
*,
29022902
channel: str,
2903-
thread_ts: Optional[str] = None,
2903+
thread_ts: str,
29042904
markdown_text: Optional[str] = None,
29052905
recipient_team_id: Optional[str] = None,
29062906
recipient_user_id: Optional[str] = None,
@@ -10164,7 +10164,7 @@ <h3>Methods</h3>
1016410164
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
1016510165
</dd>
1016610166
<dt id="slack_sdk.web.async_client.AsyncWebClient.chat_startStream"><code class="name flex">
10167-
<span>async def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
10167+
<span>async def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
1016810168
</code></dt>
1016910169
<dd>
1017010170
<details class="source">
@@ -10175,7 +10175,7 @@ <h3>Methods</h3>
1017510175
self,
1017610176
*,
1017710177
channel: str,
10178-
thread_ts: Optional[str] = None,
10178+
thread_ts: str,
1017910179
markdown_text: Optional[str] = None,
1018010180
recipient_team_id: Optional[str] = None,
1018110181
recipient_user_id: Optional[str] = None,

docs/reference/web/client.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2900,7 +2900,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
29002900
self,
29012901
*,
29022902
channel: str,
2903-
thread_ts: Optional[str] = None,
2903+
thread_ts: str,
29042904
markdown_text: Optional[str] = None,
29052905
recipient_team_id: Optional[str] = None,
29062906
recipient_user_id: Optional[str] = None,
@@ -10164,7 +10164,7 @@ <h3>Methods</h3>
1016410164
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
1016510165
</dd>
1016610166
<dt id="slack_sdk.web.client.WebClient.chat_startStream"><code class="name flex">
10167-
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
10167+
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
1016810168
</code></dt>
1016910169
<dd>
1017010170
<details class="source">
@@ -10175,7 +10175,7 @@ <h3>Methods</h3>
1017510175
self,
1017610176
*,
1017710177
channel: str,
10178-
thread_ts: Optional[str] = None,
10178+
thread_ts: str,
1017910179
markdown_text: Optional[str] = None,
1018010180
recipient_team_id: Optional[str] = None,
1018110181
recipient_user_id: Optional[str] = None,

docs/reference/web/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3261,7 +3261,7 @@ <h2 id="raises">Raises</h2>
32613261
self,
32623262
*,
32633263
channel: str,
3264-
thread_ts: Optional[str] = None,
3264+
thread_ts: str,
32653265
markdown_text: Optional[str] = None,
32663266
recipient_team_id: Optional[str] = None,
32673267
recipient_user_id: Optional[str] = None,
@@ -10525,7 +10525,7 @@ <h3>Methods</h3>
1052510525
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
1052610526
</dd>
1052710527
<dt id="slack_sdk.web.WebClient.chat_startStream"><code class="name flex">
10528-
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
10528+
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
1052910529
</code></dt>
1053010530
<dd>
1053110531
<details class="source">
@@ -10536,7 +10536,7 @@ <h3>Methods</h3>
1053610536
self,
1053710537
*,
1053810538
channel: str,
10539-
thread_ts: Optional[str] = None,
10539+
thread_ts: str,
1054010540
markdown_text: Optional[str] = None,
1054110541
recipient_team_id: Optional[str] = None,
1054210542
recipient_user_id: Optional[str] = None,

docs/reference/web/legacy_client.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2899,7 +2899,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
28992899
self,
29002900
*,
29012901
channel: str,
2902-
thread_ts: Optional[str] = None,
2902+
thread_ts: str,
29032903
markdown_text: Optional[str] = None,
29042904
recipient_team_id: Optional[str] = None,
29052905
recipient_user_id: Optional[str] = None,
@@ -10163,7 +10163,7 @@ <h3>Methods</h3>
1016310163
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
1016410164
</dd>
1016510165
<dt id="slack_sdk.web.legacy_client.LegacyWebClient.chat_startStream"><code class="name flex">
10166-
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str | None = None,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> _asyncio.Future | <a title="slack_sdk.web.legacy_slack_response.LegacySlackResponse" href="legacy_slack_response.html#slack_sdk.web.legacy_slack_response.LegacySlackResponse">LegacySlackResponse</a></span>
10166+
<span>def <span class="ident">chat_startStream</span></span>(<span>self,<br>*,<br>channel: str,<br>thread_ts: str,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>unfurl_links: bool | None = None,<br>unfurl_media: bool | None = None,<br>**kwargs) ‑> _asyncio.Future | <a title="slack_sdk.web.legacy_slack_response.LegacySlackResponse" href="legacy_slack_response.html#slack_sdk.web.legacy_slack_response.LegacySlackResponse">LegacySlackResponse</a></span>
1016710167
</code></dt>
1016810168
<dd>
1016910169
<details class="source">
@@ -10174,7 +10174,7 @@ <h3>Methods</h3>
1017410174
self,
1017510175
*,
1017610176
channel: str,
10177-
thread_ts: Optional[str] = None,
10177+
thread_ts: str,
1017810178
markdown_text: Optional[str] = None,
1017910179
recipient_team_id: Optional[str] = None,
1018010180
recipient_user_id: Optional[str] = None,

0 commit comments

Comments
 (0)