Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3006,6 +3006,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -3018,6 +3020,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down Expand Up @@ -10264,7 +10268,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.WebClient.chat_startStream"><code class="name flex">
<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>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>
<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>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10277,6 +10281,8 @@ <h3>Methods</h3>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -10289,6 +10295,8 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/file/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<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>
<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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 suggestion(non-blocking): Hmm I didn't notice this in a past change, but I am wondering if we can use a $HOME placeholder here instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

Digging into it, it's been around a year ago during Aug 2024 and it dates back to 3 year ago when v3.16.2 introduced the user paths..

I like your suggestion of replacing it with a placeholder. Let's create an issue to handle it in another PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created #1752

</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ <h3>Methods</h3>
</dd>
<dt id="slack_sdk.oauth.installation_store.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/file/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.file.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
10 changes: 9 additions & 1 deletion docs/reference/web/async_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -2902,6 +2902,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2914,6 +2916,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down Expand Up @@ -10160,7 +10164,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.async_client.AsyncWebClient.chat_startStream"><code class="name flex">
<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>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>
<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>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10173,6 +10177,8 @@ <h3>Methods</h3>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -10185,6 +10191,8 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down
10 changes: 9 additions & 1 deletion docs/reference/web/client.html
Original file line number Diff line number Diff line change
Expand Up @@ -2902,6 +2902,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2914,6 +2916,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down Expand Up @@ -10160,7 +10164,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.client.WebClient.chat_startStream"><code class="name flex">
<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>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>
<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>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10173,6 +10177,8 @@ <h3>Methods</h3>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -10185,6 +10191,8 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down
10 changes: 9 additions & 1 deletion docs/reference/web/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3263,6 +3263,8 @@ <h2 id="raises">Raises</h2>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -3275,6 +3277,8 @@ <h2 id="raises">Raises</h2>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down Expand Up @@ -10521,7 +10525,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.WebClient.chat_startStream"><code class="name flex">
<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>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>
<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>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10534,6 +10538,8 @@ <h3>Methods</h3>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -10546,6 +10552,8 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down
10 changes: 9 additions & 1 deletion docs/reference/web/legacy_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -2901,6 +2901,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2913,6 +2915,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down Expand Up @@ -10159,7 +10163,7 @@ <h3>Methods</h3>
<a href="https://api.slack.com/methods/chat.scheduledMessages.list">https://api.slack.com/methods/chat.scheduledMessages.list</a></p></div>
</dd>
<dt id="slack_sdk.web.legacy_client.LegacyWebClient.chat_startStream"><code class="name flex">
<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>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>
<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>
</code></dt>
<dd>
<details class="source">
Expand All @@ -10172,6 +10176,8 @@ <h3>Methods</h3>
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -10184,6 +10190,8 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;thread_ts&#34;: thread_ts,
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;unfurl_links&#34;: unfurl_links,
&#34;unfurl_media&#34;: unfurl_media,
}
Expand Down
4 changes: 4 additions & 0 deletions slack_sdk/web/async_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2880,6 +2880,8 @@ async def chat_startStream(
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2892,6 +2894,8 @@ async def chat_startStream(
"channel": channel,
"thread_ts": thread_ts,
"markdown_text": markdown_text,
"recipient_team_id": recipient_team_id,
"recipient_user_id": recipient_user_id,
"unfurl_links": unfurl_links,
"unfurl_media": unfurl_media,
}
Expand Down
4 changes: 4 additions & 0 deletions slack_sdk/web/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2870,6 +2870,8 @@ def chat_startStream(
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2882,6 +2884,8 @@ def chat_startStream(
"channel": channel,
"thread_ts": thread_ts,
"markdown_text": markdown_text,
"recipient_team_id": recipient_team_id,
"recipient_user_id": recipient_user_id,
"unfurl_links": unfurl_links,
"unfurl_media": unfurl_media,
}
Expand Down
4 changes: 4 additions & 0 deletions slack_sdk/web/legacy_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -2882,6 +2882,8 @@ def chat_startStream(
channel: str,
thread_ts: Optional[str] = None,
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
unfurl_links: Optional[bool] = None,
unfurl_media: Optional[bool] = None,
**kwargs,
Expand All @@ -2894,6 +2896,8 @@ def chat_startStream(
"channel": channel,
"thread_ts": thread_ts,
"markdown_text": markdown_text,
"recipient_team_id": recipient_team_id,
"recipient_user_id": recipient_user_id,
"unfurl_links": unfurl_links,
"unfurl_media": unfurl_media,
}
Expand Down
Loading