docs: autogenerate reference

Author: zimeg

docs/reference/index.html

@@ -3033,7 +3033,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     def chat_stream(
         self,
         *,
-        buffer_size: Optional[int] = 256,
+        buffer_size: int = 256,
         channel: str,
         thread_ts: str,
         recipient_team_id: Optional[str] = None,
@@ -10405,7 +10405,7 @@ <h3>Methods</h3>
 <a href="https://api.slack.com/methods/chat.stopStream">https://api.slack.com/methods/chat.stopStream</a></p></div>
 </dd>
 <dt id="slack_sdk.WebClient.chat_stream"><code class="name flex">
-<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int | None = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="web/chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
+<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="web/chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
 </code></dt>
 <dd>
 <details class="source">
@@ -10415,7 +10415,7 @@ <h3>Methods</h3>
 <pre><code class="python">def chat_stream(
     self,
     *,
-    buffer_size: Optional[int] = 256,
+    buffer_size: int = 256,
     channel: str,
     thread_ts: str,
     recipient_team_id: Optional[str] = None,

docs/reference/web/async_chat_stream.html

@@ -102,6 +102,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         self._buffer = &#34;&#34;
         self._state = &#34;starting&#34;
         self._stream_ts: Optional[str] = None
+        self._token: Optional[str] = kwargs.get(&#34;token&#34;)
         self._buffer_size = buffer_size
 
     async def append(
@@ -124,6 +125,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;
         if self._state == &#34;completed&#34;:
             raise e.SlackRequestError(f&#34;Cannot append to stream: stream state is {self._state}&#34;)
+        if kwargs.get(&#34;token&#34;):
+            self._token = kwargs.pop(&#34;token&#34;)
         self._buffer += markdown_text
         if len(self._buffer) &gt;= self._buffer_size:
             return await self._flush_buffer(**kwargs)
@@ -162,26 +165,25 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;
         if self._state == &#34;completed&#34;:
             raise e.SlackRequestError(f&#34;Cannot stop stream: stream state is {self._state}&#34;)
+        if kwargs.get(&#34;token&#34;):
+            self._token = kwargs.pop(&#34;token&#34;)
         if markdown_text:
             self._buffer += markdown_text
         if not self._stream_ts:
             response = await self._client.chat_startStream(
                 **self._stream_args,
-                **kwargs,
+                token=self._token,
             )
             if not response.get(&#34;ts&#34;):
                 raise e.SlackRequestError(&#34;Failed to stop stream: stream not started&#34;)
             self._stream_ts = str(response[&#34;ts&#34;])
             self._state = &#34;in_progress&#34;
-
-        print(f&#34;_stream_args: {self._stream_args}\n&#34;)  # todo
-        print(f&#34;_buffer: {self._buffer}\n&#34;)
-
         response = await self._client.chat_stopStream(
+            token=self._token,
             channel=self._stream_args[&#34;channel&#34;],
             ts=self._stream_ts,
             blocks=blocks,
-            markdown_text=self._buffer + (markdown_text if markdown_text is not None else &#34;&#34;),
+            markdown_text=self._buffer,
             metadata=metadata,
             **kwargs,
         )
@@ -193,17 +195,19 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         if not self._stream_ts:
             response = await self._client.chat_startStream(
                 **self._stream_args,
-                markdown_text=self._buffer,
+                token=self._token,
                 **kwargs,
+                markdown_text=self._buffer,
             )
             self._stream_ts = response.get(&#34;ts&#34;)
             self._state = &#34;in_progress&#34;
         else:
             response = await self._client.chat_appendStream(
+                token=self._token,
                 channel=self._stream_args[&#34;channel&#34;],
                 ts=self._stream_ts,
-                markdown_text=self._buffer,
                 **kwargs,
+                markdown_text=self._buffer,
             )
 
         self._buffer = &#34;&#34;
@@ -262,6 +266,8 @@ <h3>Methods</h3>
     &#34;&#34;&#34;
     if self._state == &#34;completed&#34;:
         raise e.SlackRequestError(f&#34;Cannot append to stream: stream state is {self._state}&#34;)
+    if kwargs.get(&#34;token&#34;):
+        self._token = kwargs.pop(&#34;token&#34;)
     self._buffer += markdown_text
     if len(self._buffer) &gt;= self._buffer_size:
         return await self._flush_buffer(**kwargs)
@@ -324,26 +330,25 @@ <h2 id="raises">Raises</h2>
     &#34;&#34;&#34;
     if self._state == &#34;completed&#34;:
         raise e.SlackRequestError(f&#34;Cannot stop stream: stream state is {self._state}&#34;)
+    if kwargs.get(&#34;token&#34;):
+        self._token = kwargs.pop(&#34;token&#34;)
     if markdown_text:
         self._buffer += markdown_text
     if not self._stream_ts:
         response = await self._client.chat_startStream(
             **self._stream_args,
-            **kwargs,
+            token=self._token,
         )
         if not response.get(&#34;ts&#34;):
             raise e.SlackRequestError(&#34;Failed to stop stream: stream not started&#34;)
         self._stream_ts = str(response[&#34;ts&#34;])
         self._state = &#34;in_progress&#34;
-
-    print(f&#34;_stream_args: {self._stream_args}\n&#34;)  # todo
-    print(f&#34;_buffer: {self._buffer}\n&#34;)
-
     response = await self._client.chat_stopStream(
+        token=self._token,
         channel=self._stream_args[&#34;channel&#34;],
         ts=self._stream_ts,
         blocks=blocks,
-        markdown_text=self._buffer + (markdown_text if markdown_text is not None else &#34;&#34;),
+        markdown_text=self._buffer,
         metadata=metadata,
         **kwargs,
     )

docs/reference/web/async_client.html

@@ -2929,15 +2929,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     async def chat_stream(
         self,
         *,
-        buffer_size: Optional[int] = 256,
+        buffer_size: int = 256,
         channel: str,
         thread_ts: str,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,
         unfurl_links: Optional[bool] = None,
         unfurl_media: Optional[bool] = None,
         **kwargs,
-    ) -&gt; ChatStream:
+    ) -&gt; AsyncChatStream:
         &#34;&#34;&#34;Stream markdown text into a conversation.
 
         This method provides an easy way to stream markdown text using the following endpoints:
@@ -2960,18 +2960,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         Example:
             ```python
-            streamer = client.chat_stream(
+            streamer = await client.chat_stream(
                 channel=&#34;C0123456789&#34;,
                 thread_ts=&#34;1700000001.123456&#34;,
                 recipient_team_id=&#34;T0123456789&#34;,
                 recipient_user_id=&#34;U0123456789&#34;,
             )
-            streamer.append(markdown_text=&#34;**hello wo&#34;)
-            streamer.append(markdown_text=&#34;rld!**&#34;)
-            streamer.stop()
+            await streamer.append(markdown_text=&#34;**hello wo&#34;)
+            await streamer.append(markdown_text=&#34;rld!**&#34;)
+            await streamer.stop()
             ```
         &#34;&#34;&#34;
-        return ChatStream(
+        return AsyncChatStream(
             self,
             logger=self._logger,
             channel=channel,
@@ -10301,7 +10301,7 @@ <h3>Methods</h3>
 <a href="https://api.slack.com/methods/chat.stopStream">https://api.slack.com/methods/chat.stopStream</a></p></div>
 </dd>
 <dt id="slack_sdk.web.async_client.AsyncWebClient.chat_stream"><code class="name flex">
-<span>async def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int | None = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
+<span>async def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int = 256,<br>channel: str,<br>thread_ts: str,<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_chat_stream.AsyncChatStream" href="async_chat_stream.html#slack_sdk.web.async_chat_stream.AsyncChatStream">AsyncChatStream</a></span>
 </code></dt>
 <dd>
 <details class="source">
@@ -10311,15 +10311,15 @@ <h3>Methods</h3>
 <pre><code class="python">async def chat_stream(
     self,
     *,
-    buffer_size: Optional[int] = 256,
+    buffer_size: int = 256,
     channel: str,
     thread_ts: str,
     recipient_team_id: Optional[str] = None,
     recipient_user_id: Optional[str] = None,
     unfurl_links: Optional[bool] = None,
     unfurl_media: Optional[bool] = None,
     **kwargs,
-) -&gt; ChatStream:
+) -&gt; AsyncChatStream:
     &#34;&#34;&#34;Stream markdown text into a conversation.
 
     This method provides an easy way to stream markdown text using the following endpoints:
@@ -10342,18 +10342,18 @@ <h3>Methods</h3>
 
     Example:
         ```python
-        streamer = client.chat_stream(
+        streamer = await client.chat_stream(
             channel=&#34;C0123456789&#34;,
             thread_ts=&#34;1700000001.123456&#34;,
             recipient_team_id=&#34;T0123456789&#34;,
             recipient_user_id=&#34;U0123456789&#34;,
         )
-        streamer.append(markdown_text=&#34;**hello wo&#34;)
-        streamer.append(markdown_text=&#34;rld!**&#34;)
-        streamer.stop()
+        await streamer.append(markdown_text=&#34;**hello wo&#34;)
+        await streamer.append(markdown_text=&#34;rld!**&#34;)
+        await streamer.stop()
         ```
     &#34;&#34;&#34;
-    return ChatStream(
+    return AsyncChatStream(
         self,
         logger=self._logger,
         channel=channel,
@@ -10393,15 +10393,15 @@ <h2 id="args">Args</h2>
 <h2 id="returns">Returns</h2>
 <p>ChatStreamer instance for managing the stream</p>
 <h2 id="example">Example</h2>
-<pre><code class="language-python">streamer = client.chat_stream(
+<pre><code class="language-python">streamer = await client.chat_stream(
     channel=&quot;C0123456789&quot;,
     thread_ts=&quot;1700000001.123456&quot;,
     recipient_team_id=&quot;T0123456789&quot;,
     recipient_user_id=&quot;U0123456789&quot;,
 )
-streamer.append(markdown_text=&quot;**hello wo&quot;)
-streamer.append(markdown_text=&quot;rld!**&quot;)
-streamer.stop()
+await streamer.append(markdown_text=&quot;**hello wo&quot;)
+await streamer.append(markdown_text=&quot;rld!**&quot;)
+await streamer.stop()
 </code></pre></div>
 </dd>
 <dt id="slack_sdk.web.async_client.AsyncWebClient.chat_unfurl"><code class="name flex">

docs/reference/web/chat_stream.html

@@ -102,6 +102,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         self._buffer = &#34;&#34;
         self._state = &#34;starting&#34;
         self._stream_ts: Optional[str] = None
+        self._token: Optional[str] = kwargs.get(&#34;token&#34;)
         self._buffer_size = buffer_size
 
     def append(
@@ -124,6 +125,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;
         if self._state == &#34;completed&#34;:
             raise e.SlackRequestError(f&#34;Cannot append to stream: stream state is {self._state}&#34;)
+        if kwargs.get(&#34;token&#34;):
+            self._token = kwargs.pop(&#34;token&#34;)
         self._buffer += markdown_text
         if len(self._buffer) &gt;= self._buffer_size:
             return self._flush_buffer(**kwargs)
@@ -162,18 +165,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;
         if self._state == &#34;completed&#34;:
             raise e.SlackRequestError(f&#34;Cannot stop stream: stream state is {self._state}&#34;)
+        if kwargs.get(&#34;token&#34;):
+            self._token = kwargs.pop(&#34;token&#34;)
         if markdown_text:
             self._buffer += markdown_text
         if not self._stream_ts:
             response = self._client.chat_startStream(
                 **self._stream_args,
-                **kwargs,
+                token=self._token,
             )
             if not response.get(&#34;ts&#34;):
                 raise e.SlackRequestError(&#34;Failed to stop stream: stream not started&#34;)
             self._stream_ts = str(response[&#34;ts&#34;])
             self._state = &#34;in_progress&#34;
         response = self._client.chat_stopStream(
+            token=self._token,
             channel=self._stream_args[&#34;channel&#34;],
             ts=self._stream_ts,
             blocks=blocks,
@@ -189,17 +195,19 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         if not self._stream_ts:
             response = self._client.chat_startStream(
                 **self._stream_args,
-                markdown_text=self._buffer,
+                token=self._token,
                 **kwargs,
+                markdown_text=self._buffer,
             )
             self._stream_ts = response.get(&#34;ts&#34;)
             self._state = &#34;in_progress&#34;
         else:
             response = self._client.chat_appendStream(
+                token=self._token,
                 channel=self._stream_args[&#34;channel&#34;],
                 ts=self._stream_ts,
-                markdown_text=self._buffer,
                 **kwargs,
+                markdown_text=self._buffer,
             )
 
         self._buffer = &#34;&#34;
@@ -258,6 +266,8 @@ <h3>Methods</h3>
     &#34;&#34;&#34;
     if self._state == &#34;completed&#34;:
         raise e.SlackRequestError(f&#34;Cannot append to stream: stream state is {self._state}&#34;)
+    if kwargs.get(&#34;token&#34;):
+        self._token = kwargs.pop(&#34;token&#34;)
     self._buffer += markdown_text
     if len(self._buffer) &gt;= self._buffer_size:
         return self._flush_buffer(**kwargs)
@@ -320,18 +330,21 @@ <h2 id="raises">Raises</h2>
     &#34;&#34;&#34;
     if self._state == &#34;completed&#34;:
         raise e.SlackRequestError(f&#34;Cannot stop stream: stream state is {self._state}&#34;)
+    if kwargs.get(&#34;token&#34;):
+        self._token = kwargs.pop(&#34;token&#34;)
     if markdown_text:
         self._buffer += markdown_text
     if not self._stream_ts:
         response = self._client.chat_startStream(
             **self._stream_args,
-            **kwargs,
+            token=self._token,
         )
         if not response.get(&#34;ts&#34;):
             raise e.SlackRequestError(&#34;Failed to stop stream: stream not started&#34;)
         self._stream_ts = str(response[&#34;ts&#34;])
         self._state = &#34;in_progress&#34;
     response = self._client.chat_stopStream(
+        token=self._token,
         channel=self._stream_args[&#34;channel&#34;],
         ts=self._stream_ts,
         blocks=blocks,

docs/reference/web/client.html

@@ -2929,7 +2929,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     def chat_stream(
         self,
         *,
-        buffer_size: Optional[int] = 256,
+        buffer_size: int = 256,
         channel: str,
         thread_ts: str,
         recipient_team_id: Optional[str] = None,
@@ -10301,7 +10301,7 @@ <h3>Methods</h3>
 <a href="https://api.slack.com/methods/chat.stopStream">https://api.slack.com/methods/chat.stopStream</a></p></div>
 </dd>
 <dt id="slack_sdk.web.client.WebClient.chat_stream"><code class="name flex">
-<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int | None = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
+<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
 </code></dt>
 <dd>
 <details class="source">
@@ -10311,7 +10311,7 @@ <h3>Methods</h3>
 <pre><code class="python">def chat_stream(
     self,
     *,
-    buffer_size: Optional[int] = 256,
+    buffer_size: int = 256,
     channel: str,
     thread_ts: str,
     recipient_team_id: Optional[str] = None,

docs/reference/web/index.html

@@ -3298,7 +3298,7 @@ <h2 id="raises">Raises</h2>
     def chat_stream(
         self,
         *,
-        buffer_size: Optional[int] = 256,
+        buffer_size: int = 256,
         channel: str,
         thread_ts: str,
         recipient_team_id: Optional[str] = None,
@@ -10670,7 +10670,7 @@ <h3>Methods</h3>
 <a href="https://api.slack.com/methods/chat.stopStream">https://api.slack.com/methods/chat.stopStream</a></p></div>
 </dd>
 <dt id="slack_sdk.web.WebClient.chat_stream"><code class="name flex">
-<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int | None = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
+<span>def <span class="ident">chat_stream</span></span>(<span>self,<br>*,<br>buffer_size: int = 256,<br>channel: str,<br>thread_ts: str,<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.chat_stream.ChatStream" href="chat_stream.html#slack_sdk.web.chat_stream.ChatStream">ChatStream</a></span>
 </code></dt>
 <dd>
 <details class="source">
@@ -10680,7 +10680,7 @@ <h3>Methods</h3>
 <pre><code class="python">def chat_stream(
     self,
     *,
-    buffer_size: Optional[int] = 256,
+    buffer_size: int = 256,
     channel: str,
     thread_ts: str,
     recipient_team_id: Optional[str] = None,