Skip to content

Commit 0c6f520

Browse files
committed
Correct attachment code docs
1 parent dcacdc1 commit 0c6f520

File tree

8 files changed

+1128
-17
lines changed

8 files changed

+1128
-17
lines changed

docs/api-docs/slack_sdk/audit_logs/v1/logs.html

+367-4
Large diffs are not rendered by default.

docs/api-docs/slack_sdk/index.html

+125-1
Original file line numberDiff line numberDiff line change
@@ -1032,6 +1032,48 @@ <h2 id="note">Note</h2>
10321032
kwargs.update({&#34;channel_id&#34;: channel_id, &#34;duration_days&#34;: duration_days})
10331033
return self.api_call(&#34;admin.conversations.setCustomRetention&#34;, params=kwargs)
10341034

1035+
def admin_conversations_bulkArchive(
1036+
self,
1037+
*,
1038+
channel_ids: Union[Sequence[str], str],
1039+
**kwargs,
1040+
) -&gt; SlackResponse:
1041+
&#34;&#34;&#34;Archive public or private channels in bulk.
1042+
https://api.slack.com/methods/admin.conversations.bulkArchive
1043+
&#34;&#34;&#34;
1044+
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
1045+
return self.api_call(&#34;admin.conversations.bulkArchive&#34;, params=kwargs)
1046+
1047+
def admin_conversations_bulkDelete(
1048+
self,
1049+
*,
1050+
channel_ids: Union[Sequence[str], str],
1051+
**kwargs,
1052+
) -&gt; SlackResponse:
1053+
&#34;&#34;&#34;Delete public or private channels in bulk.
1054+
https://slack.com/api/admin.conversations.bulkDelete
1055+
&#34;&#34;&#34;
1056+
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
1057+
return self.api_call(&#34;admin.conversations.bulkDelete&#34;, params=kwargs)
1058+
1059+
def admin_conversations_bulkMove(
1060+
self,
1061+
*,
1062+
channel_ids: Union[Sequence[str], str],
1063+
target_team_id: str,
1064+
**kwargs,
1065+
) -&gt; SlackResponse:
1066+
&#34;&#34;&#34;Move public or private channels in bulk.
1067+
https://api.slack.com/methods/admin.conversations.bulkMove
1068+
&#34;&#34;&#34;
1069+
kwargs.update(
1070+
{
1071+
&#34;target_team_id&#34;: target_team_id,
1072+
&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids,
1073+
}
1074+
)
1075+
return self.api_call(&#34;admin.conversations.bulkMove&#34;, params=kwargs)
1076+
10351077
def admin_emoji_add(
10361078
self,
10371079
*,
@@ -2921,11 +2963,13 @@ <h2 id="note">Note</h2>
29212963

29222964
def emoji_list(
29232965
self,
2966+
include_categories: Optional[bool] = None,
29242967
**kwargs,
29252968
) -&gt; SlackResponse:
29262969
&#34;&#34;&#34;Lists custom emoji for a team.
29272970
https://api.slack.com/methods/emoji.list
29282971
&#34;&#34;&#34;
2972+
kwargs.update({&#34;include_categories&#34;: include_categories})
29292973
return self.api_call(&#34;emoji.list&#34;, http_verb=&#34;GET&#34;, params=kwargs)
29302974

29312975
def files_comments_delete(
@@ -5375,6 +5419,81 @@ <h3>Methods</h3>
53755419
return self.api_call(&#34;admin.conversations.archive&#34;, params=kwargs)</code></pre>
53765420
</details>
53775421
</dd>
5422+
<dt id="slack_sdk.WebClient.admin_conversations_bulkArchive"><code class="name flex">
5423+
<span>def <span class="ident">admin_conversations_bulkArchive</span></span>(<span>self, *, channel_ids: Union[str, Sequence[str]], **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
5424+
</code></dt>
5425+
<dd>
5426+
<div class="desc"><p>Archive public or private channels in bulk.
5427+
<a href="https://api.slack.com/methods/admin.conversations.bulkArchive">https://api.slack.com/methods/admin.conversations.bulkArchive</a></p></div>
5428+
<details class="source">
5429+
<summary>
5430+
<span>Expand source code</span>
5431+
</summary>
5432+
<pre><code class="python">def admin_conversations_bulkArchive(
5433+
self,
5434+
*,
5435+
channel_ids: Union[Sequence[str], str],
5436+
**kwargs,
5437+
) -&gt; SlackResponse:
5438+
&#34;&#34;&#34;Archive public or private channels in bulk.
5439+
https://api.slack.com/methods/admin.conversations.bulkArchive
5440+
&#34;&#34;&#34;
5441+
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
5442+
return self.api_call(&#34;admin.conversations.bulkArchive&#34;, params=kwargs)</code></pre>
5443+
</details>
5444+
</dd>
5445+
<dt id="slack_sdk.WebClient.admin_conversations_bulkDelete"><code class="name flex">
5446+
<span>def <span class="ident">admin_conversations_bulkDelete</span></span>(<span>self, *, channel_ids: Union[str, Sequence[str]], **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
5447+
</code></dt>
5448+
<dd>
5449+
<div class="desc"><p>Delete public or private channels in bulk.
5450+
<a href="https://slack.com/api/admin.conversations.bulkDelete">https://slack.com/api/admin.conversations.bulkDelete</a></p></div>
5451+
<details class="source">
5452+
<summary>
5453+
<span>Expand source code</span>
5454+
</summary>
5455+
<pre><code class="python">def admin_conversations_bulkDelete(
5456+
self,
5457+
*,
5458+
channel_ids: Union[Sequence[str], str],
5459+
**kwargs,
5460+
) -&gt; SlackResponse:
5461+
&#34;&#34;&#34;Delete public or private channels in bulk.
5462+
https://slack.com/api/admin.conversations.bulkDelete
5463+
&#34;&#34;&#34;
5464+
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
5465+
return self.api_call(&#34;admin.conversations.bulkDelete&#34;, params=kwargs)</code></pre>
5466+
</details>
5467+
</dd>
5468+
<dt id="slack_sdk.WebClient.admin_conversations_bulkMove"><code class="name flex">
5469+
<span>def <span class="ident">admin_conversations_bulkMove</span></span>(<span>self, *, channel_ids: Union[str, Sequence[str]], target_team_id: str, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
5470+
</code></dt>
5471+
<dd>
5472+
<div class="desc"><p>Move public or private channels in bulk.
5473+
<a href="https://api.slack.com/methods/admin.conversations.bulkMove">https://api.slack.com/methods/admin.conversations.bulkMove</a></p></div>
5474+
<details class="source">
5475+
<summary>
5476+
<span>Expand source code</span>
5477+
</summary>
5478+
<pre><code class="python">def admin_conversations_bulkMove(
5479+
self,
5480+
*,
5481+
channel_ids: Union[Sequence[str], str],
5482+
target_team_id: str,
5483+
**kwargs,
5484+
) -&gt; SlackResponse:
5485+
&#34;&#34;&#34;Move public or private channels in bulk.
5486+
https://api.slack.com/methods/admin.conversations.bulkMove
5487+
&#34;&#34;&#34;
5488+
kwargs.update(
5489+
{
5490+
&#34;target_team_id&#34;: target_team_id,
5491+
&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids,
5492+
}
5493+
)
5494+
return self.api_call(&#34;admin.conversations.bulkMove&#34;, params=kwargs)</code></pre>
5495+
</details>
5496+
</dd>
53785497
<dt id="slack_sdk.WebClient.admin_conversations_convertToPrivate"><code class="name flex">
53795498
<span>def <span class="ident">admin_conversations_convertToPrivate</span></span>(<span>self, *, channel_id: str, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
53805499
</code></dt>
@@ -9045,7 +9164,7 @@ <h3>Methods</h3>
90459164
</details>
90469165
</dd>
90479166
<dt id="slack_sdk.WebClient.emoji_list"><code class="name flex">
9048-
<span>def <span class="ident">emoji_list</span></span>(<span>self, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
9167+
<span>def <span class="ident">emoji_list</span></span>(<span>self, include_categories: Optional[bool] = None, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="web/slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
90499168
</code></dt>
90509169
<dd>
90519170
<div class="desc"><p>Lists custom emoji for a team.
@@ -9056,11 +9175,13 @@ <h3>Methods</h3>
90569175
</summary>
90579176
<pre><code class="python">def emoji_list(
90589177
self,
9178+
include_categories: Optional[bool] = None,
90599179
**kwargs,
90609180
) -&gt; SlackResponse:
90619181
&#34;&#34;&#34;Lists custom emoji for a team.
90629182
https://api.slack.com/methods/emoji.list
90639183
&#34;&#34;&#34;
9184+
kwargs.update({&#34;include_categories&#34;: include_categories})
90649185
return self.api_call(&#34;emoji.list&#34;, http_verb=&#34;GET&#34;, params=kwargs)</code></pre>
90659186
</details>
90669187
</dd>
@@ -12565,6 +12686,9 @@ <h4><code><a title="slack_sdk.WebClient" href="#slack_sdk.WebClient">WebClient</
1256512686
<li><code><a title="slack_sdk.WebClient.admin_barriers_list" href="#slack_sdk.WebClient.admin_barriers_list">admin_barriers_list</a></code></li>
1256612687
<li><code><a title="slack_sdk.WebClient.admin_barriers_update" href="#slack_sdk.WebClient.admin_barriers_update">admin_barriers_update</a></code></li>
1256712688
<li><code><a title="slack_sdk.WebClient.admin_conversations_archive" href="#slack_sdk.WebClient.admin_conversations_archive">admin_conversations_archive</a></code></li>
12689+
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkArchive" href="#slack_sdk.WebClient.admin_conversations_bulkArchive">admin_conversations_bulkArchive</a></code></li>
12690+
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkDelete" href="#slack_sdk.WebClient.admin_conversations_bulkDelete">admin_conversations_bulkDelete</a></code></li>
12691+
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkMove" href="#slack_sdk.WebClient.admin_conversations_bulkMove">admin_conversations_bulkMove</a></code></li>
1256812692
<li><code><a title="slack_sdk.WebClient.admin_conversations_convertToPrivate" href="#slack_sdk.WebClient.admin_conversations_convertToPrivate">admin_conversations_convertToPrivate</a></code></li>
1256912693
<li><code><a title="slack_sdk.WebClient.admin_conversations_create" href="#slack_sdk.WebClient.admin_conversations_create">admin_conversations_create</a></code></li>
1257012694
<li><code><a title="slack_sdk.WebClient.admin_conversations_delete" href="#slack_sdk.WebClient.admin_conversations_delete">admin_conversations_delete</a></code></li>

docs/api-docs/slack_sdk/models/attachments/index.html

+3-6
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,7 @@ <h1 class="title">Module <code>slack_sdk.models.attachments</code></h1>
352352
table-like way. For best results, include no more than 2-3 field
353353
objects.
354354
color: Changes the color of the border on the left side of this attachment
355-
from the default gray. Can either be one of &#34;good&#34; (green), &#34;warning&#34;
356-
(yellow), &#34;danger&#34; (red), or any hex color code (eg. #439FE0)
355+
from the default gray. Can be any hex color code (eg. #439FE0)
357356
markdown_in: An array of field names that should be formatted by
358357
markdown syntax - allowed values: &#34;pretext&#34;, &#34;text&#34;, &#34;fields&#34;
359358
title: Large title text near the top of the attachment.
@@ -1399,8 +1398,7 @@ <h2 id="args">Args</h2>
13991398
objects.</dd>
14001399
<dt><strong><code>color</code></strong></dt>
14011400
<dd>Changes the color of the border on the left side of this attachment
1402-
from the default gray. Can either be one of "good" (green), "warning"
1403-
(yellow), "danger" (red), or any hex color code (eg. #439FE0)</dd>
1401+
from the default gray. Can be any hex color code (eg. #439FE0)</dd>
14041402
<dt><strong><code>markdown_in</code></strong></dt>
14051403
<dd>An array of field names that should be formatted by
14061404
markdown syntax - allowed values: "pretext", "text", "fields"</dd>
@@ -1519,8 +1517,7 @@ <h2 id="args">Args</h2>
15191517
table-like way. For best results, include no more than 2-3 field
15201518
objects.
15211519
color: Changes the color of the border on the left side of this attachment
1522-
from the default gray. Can either be one of &#34;good&#34; (green), &#34;warning&#34;
1523-
(yellow), &#34;danger&#34; (red), or any hex color code (eg. #439FE0)
1520+
from the default gray. Can be any hex color code (eg. #439FE0)
15241521
markdown_in: An array of field names that should be formatted by
15251522
markdown syntax - allowed values: &#34;pretext&#34;, &#34;text&#34;, &#34;fields&#34;
15261523
title: Large title text near the top of the attachment.

0 commit comments

Comments
 (0)