Skip to content

Commit 8a8ecb3

Browse files
committed
style: lint
1 parent b7964ad commit 8a8ecb3

10 files changed

Lines changed: 432 additions & 258 deletions

File tree

docs/reference/index.html

Lines changed: 71 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3030,6 +3030,32 @@ <h2 class="section-title" id="header-classes">Classes</h2>
30303030
kwargs = _remove_none_values(kwargs)
30313031
return self.api_call(&#34;chat.startStream&#34;, json=kwargs)
30323032

3033+
def chat_stopStream(
3034+
self,
3035+
*,
3036+
channel: str,
3037+
ts: str,
3038+
markdown_text: Optional[str] = None,
3039+
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
3040+
metadata: Optional[Union[Dict, Metadata]] = None,
3041+
**kwargs,
3042+
) -&gt; SlackResponse:
3043+
&#34;&#34;&#34;Stops a streaming conversation.
3044+
https://api.slack.com/methods/chat.stopStream
3045+
&#34;&#34;&#34;
3046+
kwargs.update(
3047+
{
3048+
&#34;channel&#34;: channel,
3049+
&#34;ts&#34;: ts,
3050+
&#34;markdown_text&#34;: markdown_text,
3051+
&#34;blocks&#34;: blocks,
3052+
&#34;metadata&#34;: metadata,
3053+
}
3054+
)
3055+
_parse_web_class_objects(kwargs)
3056+
kwargs = _remove_none_values(kwargs)
3057+
return self.api_call(&#34;chat.stopStream&#34;, json=kwargs)
3058+
30333059
def chat_stream(
30343060
self,
30353061
*,
@@ -3042,19 +3068,27 @@ <h2 class="section-title" id="header-classes">Classes</h2>
30423068
) -&gt; ChatStream:
30433069
&#34;&#34;&#34;Stream markdown text into a conversation.
30443070

3045-
This method starts a new chat stream in a coversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as &#34;blocks&#34; for gathering feedback.
3071+
This method starts a new chat stream in a coversation that can be appended to. After appending an entire message,
3072+
the stream can be stopped with concluding arguments such as &#34;blocks&#34; for gathering feedback.
30463073

30473074
The following methods are used:
30483075

3049-
- chat.startStream: Starts a new streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.startStream).
3050-
- chat.appendStream: Appends text to an existing streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.appendStream).
3051-
- chat.stopStream: Stops a streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.stopStream).
3076+
- chat.startStream: Starts a new streaming conversation.
3077+
[Reference](https://docs.slack.dev/reference/methods/chat.startStream).
3078+
- chat.appendStream: Appends text to an existing streaming conversation.
3079+
[Reference](https://docs.slack.dev/reference/methods/chat.appendStream).
3080+
- chat.stopStream: Stops a streaming conversation.
3081+
[Reference](https://docs.slack.dev/reference/methods/chat.stopStream).
30523082

30533083
Args:
3054-
buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. Default: 256.
3084+
buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
3085+
decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
3086+
Default: 256.
30553087
channel: An encoded ID that represents a channel, private group, or DM.
3056-
thread_ts: Provide another message&#39;s ts value to reply to. Streamed messages should always be replies to a user request.
3057-
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.
3088+
thread_ts: Provide another message&#39;s ts value to reply to. Streamed messages should always be replies to a user
3089+
request.
3090+
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when
3091+
streaming to channels.
30583092
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
30593093
**kwargs: Additional arguments passed to the underlying API calls.
30603094

@@ -3085,32 +3119,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
30853119
**kwargs,
30863120
)
30873121

3088-
def chat_stopStream(
3089-
self,
3090-
*,
3091-
channel: str,
3092-
ts: str,
3093-
markdown_text: Optional[str] = None,
3094-
blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
3095-
metadata: Optional[Union[Dict, Metadata]] = None,
3096-
**kwargs,
3097-
) -&gt; SlackResponse:
3098-
&#34;&#34;&#34;Stops a streaming conversation.
3099-
https://api.slack.com/methods/chat.stopStream
3100-
&#34;&#34;&#34;
3101-
kwargs.update(
3102-
{
3103-
&#34;channel&#34;: channel,
3104-
&#34;ts&#34;: ts,
3105-
&#34;markdown_text&#34;: markdown_text,
3106-
&#34;blocks&#34;: blocks,
3107-
&#34;metadata&#34;: metadata,
3108-
}
3109-
)
3110-
_parse_web_class_objects(kwargs)
3111-
kwargs = _remove_none_values(kwargs)
3112-
return self.api_call(&#34;chat.stopStream&#34;, json=kwargs)
3113-
31143122
def chat_unfurl(
31153123
self,
31163124
*,
@@ -10421,19 +10429,27 @@ <h3>Methods</h3>
1042110429
) -&gt; ChatStream:
1042210430
&#34;&#34;&#34;Stream markdown text into a conversation.
1042310431

10424-
This method starts a new chat stream in a coversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as &#34;blocks&#34; for gathering feedback.
10432+
This method starts a new chat stream in a coversation that can be appended to. After appending an entire message,
10433+
the stream can be stopped with concluding arguments such as &#34;blocks&#34; for gathering feedback.
1042510434

1042610435
The following methods are used:
1042710436

10428-
- chat.startStream: Starts a new streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.startStream).
10429-
- chat.appendStream: Appends text to an existing streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.appendStream).
10430-
- chat.stopStream: Stops a streaming conversation. [Reference](https://docs.slack.dev/reference/methods/chat.stopStream).
10437+
- chat.startStream: Starts a new streaming conversation.
10438+
[Reference](https://docs.slack.dev/reference/methods/chat.startStream).
10439+
- chat.appendStream: Appends text to an existing streaming conversation.
10440+
[Reference](https://docs.slack.dev/reference/methods/chat.appendStream).
10441+
- chat.stopStream: Stops a streaming conversation.
10442+
[Reference](https://docs.slack.dev/reference/methods/chat.stopStream).
1043110443

1043210444
Args:
10433-
buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. Default: 256.
10445+
buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
10446+
decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
10447+
Default: 256.
1043410448
channel: An encoded ID that represents a channel, private group, or DM.
10435-
thread_ts: Provide another message&#39;s ts value to reply to. Streamed messages should always be replies to a user request.
10436-
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.
10449+
thread_ts: Provide another message&#39;s ts value to reply to. Streamed messages should always be replies to a user
10450+
request.
10451+
recipient_team_id: The encoded ID of the team the user receiving the streaming text belongs to. Required when
10452+
streaming to channels.
1043710453
recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
1043810454
**kwargs: Additional arguments passed to the underlying API calls.
1043910455

@@ -10465,23 +10481,31 @@ <h3>Methods</h3>
1046510481
)</code></pre>
1046610482
</details>
1046710483
<div class="desc"><p>Stream markdown text into a conversation.</p>
10468-
<p>This method starts a new chat stream in a coversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as "blocks" for gathering feedback.</p>
10484+
<p>This method starts a new chat stream in a coversation that can be appended to. After appending an entire message,
10485+
the stream can be stopped with concluding arguments such as "blocks" for gathering feedback.</p>
1046910486
<p>The following methods are used:</p>
1047010487
<ul>
10471-
<li>chat.startStream: Starts a new streaming conversation. <a href="https://docs.slack.dev/reference/methods/chat.startStream">Reference</a>.</li>
10472-
<li>chat.appendStream: Appends text to an existing streaming conversation. <a href="https://docs.slack.dev/reference/methods/chat.appendStream">Reference</a>.</li>
10473-
<li>chat.stopStream: Stops a streaming conversation. <a href="https://docs.slack.dev/reference/methods/chat.stopStream">Reference</a>.</li>
10488+
<li>chat.startStream: Starts a new streaming conversation.
10489+
<a href="https://docs.slack.dev/reference/methods/chat.startStream">Reference</a>.</li>
10490+
<li>chat.appendStream: Appends text to an existing streaming conversation.
10491+
<a href="https://docs.slack.dev/reference/methods/chat.appendStream">Reference</a>.</li>
10492+
<li>chat.stopStream: Stops a streaming conversation.
10493+
<a href="https://docs.slack.dev/reference/methods/chat.stopStream">Reference</a>.</li>
1047410494
</ul>
1047510495
<h2 id="args">Args</h2>
1047610496
<dl>
1047710497
<dt><strong><code>buffer_size</code></strong></dt>
10478-
<dd>The length of markdown_text to buffer in-memory before calling a method. Increasing this value decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits. Default: 256.</dd>
10498+
<dd>The length of markdown_text to buffer in-memory before calling a method. Increasing this value
10499+
decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
10500+
Default: 256.</dd>
1047910501
<dt><strong><code>channel</code></strong></dt>
1048010502
<dd>An encoded ID that represents a channel, private group, or DM.</dd>
1048110503
<dt><strong><code>thread_ts</code></strong></dt>
10482-
<dd>Provide another message's ts value to reply to. Streamed messages should always be replies to a user request.</dd>
10504+
<dd>Provide another message's ts value to reply to. Streamed messages should always be replies to a user
10505+
request.</dd>
1048310506
<dt><strong><code>recipient_team_id</code></strong></dt>
10484-
<dd>The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.</dd>
10507+
<dd>The encoded ID of the team the user receiving the streaming text belongs to. Required when
10508+
streaming to channels.</dd>
1048510509
<dt><strong><code>recipient_user_id</code></strong></dt>
1048610510
<dd>The encoded ID of the user to receive the streaming text. Required when streaming to channels.</dd>
1048710511
<dt><strong><code>**kwargs</code></strong></dt>

0 commit comments

Comments
 (0)