Skip to content
43 changes: 37 additions & 6 deletions docs/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2755,7 +2755,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
*,
channel: str,
ts: str,
markdown_text: str,
markdown_text: Optional[str] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Appends text to an existing streaming conversation.
Expand All @@ -2766,8 +2767,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;channel&#34;: channel,
&#34;ts&#34;: ts,
&#34;markdown_text&#34;: markdown_text,
&#34;chunks&#34;: chunks,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
return self.api_call(&#34;chat.appendStream&#34;, json=kwargs)

Expand Down Expand Up @@ -3009,6 +3012,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
task_display_mode: Optional[str] = None, # timeline, plan
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Starts a new streaming conversation.
Expand All @@ -3021,8 +3026,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;chunks&#34;: chunks,
&#34;task_display_mode&#34;: task_display_mode,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
return self.api_call(&#34;chat.startStream&#34;, json=kwargs)

Expand All @@ -3034,6 +3042,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
markdown_text: Optional[str] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Stops a streaming conversation.
Expand All @@ -3046,6 +3055,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;markdown_text&#34;: markdown_text,
&#34;blocks&#34;: blocks,
&#34;metadata&#34;: metadata,
&#34;chunks&#34;: chunks,
}
)
_parse_web_class_objects(kwargs)
Expand All @@ -3060,6 +3070,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
thread_ts: str,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
task_display_mode: Optional[str] = None,
**kwargs,
) -&gt; ChatStream:
&#34;&#34;&#34;Stream markdown text into a conversation.
Expand All @@ -3086,6 +3097,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when
streaming to channels.
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
task_display_mode: Specifies how tasks are displayed in the message. A &#34;timeline&#34; displays individual tasks
with text and &#34;plan&#34; displays all tasks together.
**kwargs: Additional arguments passed to the underlying API calls.

Returns:
Expand All @@ -3111,6 +3124,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
thread_ts=thread_ts,
recipient_team_id=recipient_team_id,
recipient_user_id=recipient_user_id,
task_display_mode=task_display_mode,
buffer_size=buffer_size,
**kwargs,
)
Expand Down Expand Up @@ -10248,7 +10262,7 @@ <h3>Methods</h3>
<div class="desc"><p>Unarchives a channel.</p></div>
</dd>
<dt id="slack_sdk.WebClient.chat_appendStream"><code class="name flex">
<span>def <span class="ident">chat_appendStream</span></span>(<span>self, *, channel: str, ts: str, markdown_text: str, **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_appendStream</span></span>(<span>self,<br>*,<br>channel: str,<br>ts: str,<br>markdown_text: str | None = None,<br>chunks: Sequence[Dict | <a title="slack_sdk.models.messages.chunk.Chunk" href="models/messages/chunk.html#slack_sdk.models.messages.chunk.Chunk">Chunk</a>] | 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 @@ -10260,7 +10274,8 @@ <h3>Methods</h3>
*,
channel: str,
ts: str,
markdown_text: str,
markdown_text: Optional[str] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Appends text to an existing streaming conversation.
Expand All @@ -10271,8 +10286,10 @@ <h3>Methods</h3>
&#34;channel&#34;: channel,
&#34;ts&#34;: ts,
&#34;markdown_text&#34;: markdown_text,
&#34;chunks&#34;: chunks,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
return self.api_call(&#34;chat.appendStream&#34;, json=kwargs)</code></pre>
</details>
Expand Down Expand Up @@ -10598,7 +10615,7 @@ <h3>Methods</h3>
<a href="https://docs.slack.dev/reference/methods/chat.scheduledMessages.list">https://docs.slack.dev/reference/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,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | 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,<br>markdown_text: str | None = None,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | None = None,<br>chunks: Sequence[Dict | <a title="slack_sdk.models.messages.chunk.Chunk" href="models/messages/chunk.html#slack_sdk.models.messages.chunk.Chunk">Chunk</a>] | None = None,<br>task_display_mode: str | 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 @@ -10613,6 +10630,8 @@ <h3>Methods</h3>
markdown_text: Optional[str] = None,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
task_display_mode: Optional[str] = None, # timeline, plan
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Starts a new streaming conversation.
Expand All @@ -10625,16 +10644,19 @@ <h3>Methods</h3>
&#34;markdown_text&#34;: markdown_text,
&#34;recipient_team_id&#34;: recipient_team_id,
&#34;recipient_user_id&#34;: recipient_user_id,
&#34;chunks&#34;: chunks,
&#34;task_display_mode&#34;: task_display_mode,
}
)
_parse_web_class_objects(kwargs)
kwargs = _remove_none_values(kwargs)
return self.api_call(&#34;chat.startStream&#34;, json=kwargs)</code></pre>
</details>
<div class="desc"><p>Starts a new streaming conversation.
<a href="https://docs.slack.dev/reference/methods/chat.startStream">https://docs.slack.dev/reference/methods/chat.startStream</a></p></div>
</dd>
<dt id="slack_sdk.WebClient.chat_stopStream"><code class="name flex">
<span>def <span class="ident">chat_stopStream</span></span>(<span>self,<br>*,<br>channel: str,<br>ts: str,<br>markdown_text: str | None = None,<br>blocks: str | Sequence[Dict | <a title="slack_sdk.models.blocks.blocks.Block" href="models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>] | None = None,<br>metadata: Dict | <a title="slack_sdk.models.metadata.Metadata" href="models/metadata/index.html#slack_sdk.models.metadata.Metadata">Metadata</a> | 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_stopStream</span></span>(<span>self,<br>*,<br>channel: str,<br>ts: str,<br>markdown_text: str | None = None,<br>blocks: str | Sequence[Dict | <a title="slack_sdk.models.blocks.blocks.Block" href="models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>] | None = None,<br>metadata: Dict | <a title="slack_sdk.models.metadata.Metadata" href="models/metadata/index.html#slack_sdk.models.metadata.Metadata">Metadata</a> | None = None,<br>chunks: Sequence[Dict | <a title="slack_sdk.models.messages.chunk.Chunk" href="models/messages/chunk.html#slack_sdk.models.messages.chunk.Chunk">Chunk</a>] | 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 @@ -10649,6 +10671,7 @@ <h3>Methods</h3>
markdown_text: Optional[str] = None,
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
metadata: Optional[Union[Dict, Metadata]] = None,
chunks: Optional[Sequence[Union[Dict, Chunk]]] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Stops a streaming conversation.
Expand All @@ -10661,6 +10684,7 @@ <h3>Methods</h3>
&#34;markdown_text&#34;: markdown_text,
&#34;blocks&#34;: blocks,
&#34;metadata&#34;: metadata,
&#34;chunks&#34;: chunks,
}
)
_parse_web_class_objects(kwargs)
Expand All @@ -10671,7 +10695,7 @@ <h3>Methods</h3>
<a href="https://docs.slack.dev/reference/methods/chat.stopStream">https://docs.slack.dev/reference/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 = 256,<br>channel: str,<br>thread_ts: str,<br>recipient_team_id: str | None = None,<br>recipient_user_id: str | 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>task_display_mode: str | 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">
Expand All @@ -10686,6 +10710,7 @@ <h3>Methods</h3>
thread_ts: str,
recipient_team_id: Optional[str] = None,
recipient_user_id: Optional[str] = None,
task_display_mode: Optional[str] = None,
**kwargs,
) -&gt; ChatStream:
&#34;&#34;&#34;Stream markdown text into a conversation.
Expand All @@ -10712,6 +10737,8 @@ <h3>Methods</h3>
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when
streaming to channels.
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
task_display_mode: Specifies how tasks are displayed in the message. A &#34;timeline&#34; displays individual tasks
with text and &#34;plan&#34; displays all tasks together.
**kwargs: Additional arguments passed to the underlying API calls.

Returns:
Expand All @@ -10737,6 +10764,7 @@ <h3>Methods</h3>
thread_ts=thread_ts,
recipient_team_id=recipient_team_id,
recipient_user_id=recipient_user_id,
task_display_mode=task_display_mode,
buffer_size=buffer_size,
**kwargs,
)</code></pre>
Expand Down Expand Up @@ -10769,6 +10797,9 @@ <h2 id="args">Args</h2>
streaming to channels.</dd>
<dt><strong><code>recipient_user_id</code></strong></dt>
<dd>The encoded ID of the user to receive the streaming text. Required when streaming to channels.</dd>
<dt><strong><code>task_display_mode</code></strong></dt>
<dd>Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
with text and "plan" displays all tasks together.</dd>
<dt><strong><code>**kwargs</code></strong></dt>
<dd>Additional arguments passed to the underlying API calls.</dd>
</dl>
Expand Down
1 change: 1 addition & 0 deletions docs/reference/models/basic_objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ <h3>Subclasses</h3>
<li><a title="slack_sdk.models.dialogs.AbstractDialogSelector" href="dialogs/index.html#slack_sdk.models.dialogs.AbstractDialogSelector">AbstractDialogSelector</a></li>
<li><a title="slack_sdk.models.dialogs.DialogBuilder" href="dialogs/index.html#slack_sdk.models.dialogs.DialogBuilder">DialogBuilder</a></li>
<li><a title="slack_sdk.models.dialogs.DialogTextComponent" href="dialogs/index.html#slack_sdk.models.dialogs.DialogTextComponent">DialogTextComponent</a></li>
<li><a title="slack_sdk.models.messages.chunk.Chunk" href="messages/chunk.html#slack_sdk.models.messages.chunk.Chunk">Chunk</a></li>
<li><a title="slack_sdk.models.messages.message.Message" href="messages/message.html#slack_sdk.models.messages.message.Message">Message</a></li>
<li><a title="slack_sdk.models.metadata.ContentItemEntityFields" href="metadata/index.html#slack_sdk.models.metadata.ContentItemEntityFields">ContentItemEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.EntityActionButton" href="metadata/index.html#slack_sdk.models.metadata.EntityActionButton">EntityActionButton</a></li>
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/models/blocks/basic_components.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.ConfirmObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>confirm: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>confirm: <a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -324,7 +324,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.DispatchActionConfig.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>config: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>config: <a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -446,7 +446,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>feedback_button: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a>') | Dict[str, Any])</span>
<span>def <span class="ident">parse</span></span>(<span>feedback_button: <a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a> | Dict[str, Any])</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -907,7 +907,7 @@ <h3>Static methods</h3>
<div class="desc"><p>Creates a simple Option instance with the same value and label</p></div>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.Option.parse_all"><code class="name flex">
<span>def <span class="ident">parse_all</span></span>(<span>options: Sequence[Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>')] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None</span>
<span>def <span class="ident">parse_all</span></span>(<span>options: Sequence[Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.Option" href="#slack_sdk.models.blocks.basic_components.Option">Option</a>] | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -1105,7 +1105,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.OptionGroup.parse_all"><code class="name flex">
<span>def <span class="ident">parse_all</span></span>(<span>option_groups: Sequence[Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>')] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None</span>
<span>def <span class="ident">parse_all</span></span>(<span>option_groups: Sequence[Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None) ‑> List[<a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a>] | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -1536,7 +1536,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.TextObject.parse"><code class="name flex">
<span>def <span class="ident">parse</span></span>(<span>text: str | Dict[str, Any] | ForwardRef('<a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>'),<br>default_type: str = 'mrkdwn') ‑> <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
<span>def <span class="ident">parse</span></span>(<span>text: str | Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>,<br>default_type: str = 'mrkdwn') ‑> <a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a> | None</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
Loading