Skip to content

Commit

Permalink
Correct attachment code docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seratch committed Feb 16, 2023
1 parent dcacdc1 commit 0c6f520
Show file tree
Hide file tree
Showing 8 changed files with 1,128 additions and 17 deletions.
371 changes: 367 additions & 4 deletions docs/api-docs/slack_sdk/audit_logs/v1/logs.html

Large diffs are not rendered by default.

126 changes: 125 additions & 1 deletion docs/api-docs/slack_sdk/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1032,6 +1032,48 @@ <h2 id="note">Note</h2>
kwargs.update({&#34;channel_id&#34;: channel_id, &#34;duration_days&#34;: duration_days})
return self.api_call(&#34;admin.conversations.setCustomRetention&#34;, params=kwargs)

def admin_conversations_bulkArchive(
self,
*,
channel_ids: Union[Sequence[str], str],
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Archive public or private channels in bulk.
https://api.slack.com/methods/admin.conversations.bulkArchive
&#34;&#34;&#34;
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call(&#34;admin.conversations.bulkArchive&#34;, params=kwargs)

def admin_conversations_bulkDelete(
self,
*,
channel_ids: Union[Sequence[str], str],
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Delete public or private channels in bulk.
https://slack.com/api/admin.conversations.bulkDelete
&#34;&#34;&#34;
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call(&#34;admin.conversations.bulkDelete&#34;, params=kwargs)

def admin_conversations_bulkMove(
self,
*,
channel_ids: Union[Sequence[str], str],
target_team_id: str,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Move public or private channels in bulk.
https://api.slack.com/methods/admin.conversations.bulkMove
&#34;&#34;&#34;
kwargs.update(
{
&#34;target_team_id&#34;: target_team_id,
&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids,
}
)
return self.api_call(&#34;admin.conversations.bulkMove&#34;, params=kwargs)

def admin_emoji_add(
self,
*,
Expand Down Expand Up @@ -2921,11 +2963,13 @@ <h2 id="note">Note</h2>

def emoji_list(
self,
include_categories: Optional[bool] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Lists custom emoji for a team.
https://api.slack.com/methods/emoji.list
&#34;&#34;&#34;
kwargs.update({&#34;include_categories&#34;: include_categories})
return self.api_call(&#34;emoji.list&#34;, http_verb=&#34;GET&#34;, params=kwargs)

def files_comments_delete(
Expand Down Expand Up @@ -5375,6 +5419,81 @@ <h3>Methods</h3>
return self.api_call(&#34;admin.conversations.archive&#34;, params=kwargs)</code></pre>
</details>
</dd>
<dt id="slack_sdk.WebClient.admin_conversations_bulkArchive"><code class="name flex">
<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>
</code></dt>
<dd>
<div class="desc"><p>Archive public or private channels in bulk.
<a href="https://api.slack.com/methods/admin.conversations.bulkArchive">https://api.slack.com/methods/admin.conversations.bulkArchive</a></p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def admin_conversations_bulkArchive(
self,
*,
channel_ids: Union[Sequence[str], str],
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Archive public or private channels in bulk.
https://api.slack.com/methods/admin.conversations.bulkArchive
&#34;&#34;&#34;
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call(&#34;admin.conversations.bulkArchive&#34;, params=kwargs)</code></pre>
</details>
</dd>
<dt id="slack_sdk.WebClient.admin_conversations_bulkDelete"><code class="name flex">
<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>
</code></dt>
<dd>
<div class="desc"><p>Delete public or private channels in bulk.
<a href="https://slack.com/api/admin.conversations.bulkDelete">https://slack.com/api/admin.conversations.bulkDelete</a></p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def admin_conversations_bulkDelete(
self,
*,
channel_ids: Union[Sequence[str], str],
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Delete public or private channels in bulk.
https://slack.com/api/admin.conversations.bulkDelete
&#34;&#34;&#34;
kwargs.update({&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids})
return self.api_call(&#34;admin.conversations.bulkDelete&#34;, params=kwargs)</code></pre>
</details>
</dd>
<dt id="slack_sdk.WebClient.admin_conversations_bulkMove"><code class="name flex">
<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>
</code></dt>
<dd>
<div class="desc"><p>Move public or private channels in bulk.
<a href="https://api.slack.com/methods/admin.conversations.bulkMove">https://api.slack.com/methods/admin.conversations.bulkMove</a></p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def admin_conversations_bulkMove(
self,
*,
channel_ids: Union[Sequence[str], str],
target_team_id: str,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Move public or private channels in bulk.
https://api.slack.com/methods/admin.conversations.bulkMove
&#34;&#34;&#34;
kwargs.update(
{
&#34;target_team_id&#34;: target_team_id,
&#34;channel_ids&#34;: &#34;,&#34;.join(channel_ids) if isinstance(channel_ids, (list, tuple)) else channel_ids,
}
)
return self.api_call(&#34;admin.conversations.bulkMove&#34;, params=kwargs)</code></pre>
</details>
</dd>
<dt id="slack_sdk.WebClient.admin_conversations_convertToPrivate"><code class="name flex">
<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>
</code></dt>
Expand Down Expand Up @@ -9045,7 +9164,7 @@ <h3>Methods</h3>
</details>
</dd>
<dt id="slack_sdk.WebClient.emoji_list"><code class="name flex">
<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>
<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>
</code></dt>
<dd>
<div class="desc"><p>Lists custom emoji for a team.
Expand All @@ -9056,11 +9175,13 @@ <h3>Methods</h3>
</summary>
<pre><code class="python">def emoji_list(
self,
include_categories: Optional[bool] = None,
**kwargs,
) -&gt; SlackResponse:
&#34;&#34;&#34;Lists custom emoji for a team.
https://api.slack.com/methods/emoji.list
&#34;&#34;&#34;
kwargs.update({&#34;include_categories&#34;: include_categories})
return self.api_call(&#34;emoji.list&#34;, http_verb=&#34;GET&#34;, params=kwargs)</code></pre>
</details>
</dd>
Expand Down Expand Up @@ -12565,6 +12686,9 @@ <h4><code><a title="slack_sdk.WebClient" href="#slack_sdk.WebClient">WebClient</
<li><code><a title="slack_sdk.WebClient.admin_barriers_list" href="#slack_sdk.WebClient.admin_barriers_list">admin_barriers_list</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_barriers_update" href="#slack_sdk.WebClient.admin_barriers_update">admin_barriers_update</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_archive" href="#slack_sdk.WebClient.admin_conversations_archive">admin_conversations_archive</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkArchive" href="#slack_sdk.WebClient.admin_conversations_bulkArchive">admin_conversations_bulkArchive</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkDelete" href="#slack_sdk.WebClient.admin_conversations_bulkDelete">admin_conversations_bulkDelete</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_bulkMove" href="#slack_sdk.WebClient.admin_conversations_bulkMove">admin_conversations_bulkMove</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_convertToPrivate" href="#slack_sdk.WebClient.admin_conversations_convertToPrivate">admin_conversations_convertToPrivate</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_create" href="#slack_sdk.WebClient.admin_conversations_create">admin_conversations_create</a></code></li>
<li><code><a title="slack_sdk.WebClient.admin_conversations_delete" href="#slack_sdk.WebClient.admin_conversations_delete">admin_conversations_delete</a></code></li>
Expand Down
9 changes: 3 additions & 6 deletions docs/api-docs/slack_sdk/models/attachments/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,7 @@ <h1 class="title">Module <code>slack_sdk.models.attachments</code></h1>
table-like way. For best results, include no more than 2-3 field
objects.
color: Changes the color of the border on the left side of this attachment
from the default gray. Can either be one of &#34;good&#34; (green), &#34;warning&#34;
(yellow), &#34;danger&#34; (red), or any hex color code (eg. #439FE0)
from the default gray. Can be any hex color code (eg. #439FE0)
markdown_in: An array of field names that should be formatted by
markdown syntax - allowed values: &#34;pretext&#34;, &#34;text&#34;, &#34;fields&#34;
title: Large title text near the top of the attachment.
Expand Down Expand Up @@ -1399,8 +1398,7 @@ <h2 id="args">Args</h2>
objects.</dd>
<dt><strong><code>color</code></strong></dt>
<dd>Changes the color of the border on the left side of this attachment
from the default gray. Can either be one of "good" (green), "warning"
(yellow), "danger" (red), or any hex color code (eg. #439FE0)</dd>
from the default gray. Can be any hex color code (eg. #439FE0)</dd>
<dt><strong><code>markdown_in</code></strong></dt>
<dd>An array of field names that should be formatted by
markdown syntax - allowed values: "pretext", "text", "fields"</dd>
Expand Down Expand Up @@ -1519,8 +1517,7 @@ <h2 id="args">Args</h2>
table-like way. For best results, include no more than 2-3 field
objects.
color: Changes the color of the border on the left side of this attachment
from the default gray. Can either be one of &#34;good&#34; (green), &#34;warning&#34;
(yellow), &#34;danger&#34; (red), or any hex color code (eg. #439FE0)
from the default gray. Can be any hex color code (eg. #439FE0)
markdown_in: An array of field names that should be formatted by
markdown syntax - allowed values: &#34;pretext&#34;, &#34;text&#34;, &#34;fields&#34;
title: Large title text near the top of the attachment.
Expand Down
Loading

0 comments on commit 0c6f520

Please sign in to comment.