Run ./scripts/generate_api_docs.sh

slackapi · Sep 30, 2022 · d558afa · d558afa
1 parent a564459
commit d558afa
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 14 deletions.
diff --git a/docs/api-docs/slack_sdk/index.html b/docs/api-docs/slack_sdk/index.html
@@ -2783,6 +2783,7 @@ <h2 id="note">Note</h2>
         ts: str,
         cursor: Optional[str] = None,
         inclusive: Optional[bool] = None,
+        include_all_metadata: Optional[bool] = None,
         latest: Optional[str] = None,
         limit: Optional[int] = None,
         oldest: Optional[str] = None,
@@ -2797,6 +2798,7 @@ <h2 id="note">Note</h2>
                 &#34;ts&#34;: ts,
                 &#34;cursor&#34;: cursor,
                 &#34;inclusive&#34;: inclusive,
+                &#34;include_all_metadata&#34;: include_all_metadata,
                 &#34;limit&#34;: limit,
                 &#34;latest&#34;: latest,
                 &#34;oldest&#34;: oldest,
@@ -8620,7 +8622,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="slack_sdk.WebClient.conversations_replies"><code class="name flex">
-<span>def <span class="ident">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = None, **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">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, include_all_metadata: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = 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>Retrieve a thread of messages posted to a conversation
@@ -8636,6 +8638,7 @@ <h3>Methods</h3>
     ts: str,
     cursor: Optional[str] = None,
     inclusive: Optional[bool] = None,
+    include_all_metadata: Optional[bool] = None,
     latest: Optional[str] = None,
     limit: Optional[int] = None,
     oldest: Optional[str] = None,
@@ -8650,6 +8653,7 @@ <h3>Methods</h3>
             &#34;ts&#34;: ts,
             &#34;cursor&#34;: cursor,
             &#34;inclusive&#34;: inclusive,
+            &#34;include_all_metadata&#34;: include_all_metadata,
             &#34;limit&#34;: limit,
             &#34;latest&#34;: latest,
             &#34;oldest&#34;: oldest,

diff --git a/docs/api-docs/slack_sdk/models/views/index.html b/docs/api-docs/slack_sdk/models/views/index.html
@@ -213,6 +213,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
         &#34;type&#34;,
         &#34;value&#34;,
         &#34;selected_date&#34;,
+        &#34;selected_time&#34;,
         &#34;selected_conversation&#34;,
         &#34;selected_channel&#34;,
         &#34;selected_user&#34;,
@@ -229,6 +230,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
         type: Optional[str] = None,  # skipcq: PYL-W0622
         value: Optional[str] = None,
         selected_date: Optional[str] = None,
+        selected_time: Optional[str] = None,
         selected_conversation: Optional[str] = None,
         selected_channel: Optional[str] = None,
         selected_user: Optional[str] = None,
@@ -241,6 +243,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
         self.type = type
         self.value = value
         self.selected_date = selected_date
+        self.selected_time = selected_time
         self.selected_conversation = selected_conversation
         self.selected_channel = selected_channel
         self.selected_user = selected_user
@@ -536,7 +539,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="slack_sdk.models.views.ViewStateValue"><code class="flex name class">
 <span>class <span class="ident">ViewStateValue</span></span>
-<span>(</span><span>*, type: Optional[str] = None, value: Optional[str] = None, selected_date: Optional[str] = None, selected_conversation: Optional[str] = None, selected_channel: Optional[str] = None, selected_user: Optional[str] = None, selected_option: Optional[str] = None, selected_conversations: Optional[Sequence[str]] = None, selected_channels: Optional[Sequence[str]] = None, selected_users: Optional[Sequence[str]] = None, selected_options: Optional[Sequence[Union[dict, <a title="slack_sdk.models.blocks.basic_components.Option" href="../blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Option">Option</a>]]] = None)</span>
+<span>(</span><span>*, type: Optional[str] = None, value: Optional[str] = None, selected_date: Optional[str] = None, selected_time: Optional[str] = None, selected_conversation: Optional[str] = None, selected_channel: Optional[str] = None, selected_user: Optional[str] = None, selected_option: Optional[str] = None, selected_conversations: Optional[Sequence[str]] = None, selected_channels: Optional[Sequence[str]] = None, selected_users: Optional[Sequence[str]] = None, selected_options: Optional[Sequence[Union[dict, <a title="slack_sdk.models.blocks.basic_components.Option" href="../blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Option">Option</a>]]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>The base class for JSON serializable class objects</p></div>
@@ -549,6 +552,7 @@ <h3>Inherited members</h3>
         &#34;type&#34;,
         &#34;value&#34;,
         &#34;selected_date&#34;,
+        &#34;selected_time&#34;,
         &#34;selected_conversation&#34;,
         &#34;selected_channel&#34;,
         &#34;selected_user&#34;,
@@ -565,6 +569,7 @@ <h3>Inherited members</h3>
         type: Optional[str] = None,  # skipcq: PYL-W0622
         value: Optional[str] = None,
         selected_date: Optional[str] = None,
+        selected_time: Optional[str] = None,
         selected_conversation: Optional[str] = None,
         selected_channel: Optional[str] = None,
         selected_user: Optional[str] = None,
@@ -577,6 +582,7 @@ <h3>Inherited members</h3>
         self.type = type
         self.value = value
         self.selected_date = selected_date
+        self.selected_time = selected_time
         self.selected_conversation = selected_conversation
         self.selected_channel = selected_channel
         self.selected_user = selected_user

diff --git a/docs/api-docs/slack_sdk/socket_mode/builtin/internals.html b/docs/api-docs/slack_sdk/socket_mode/builtin/internals.html
@@ -232,8 +232,6 @@ <h1 class="title">Module <code>slack_sdk.socket_mode.builtin.internals</code></h
         size = specific_buffer_size if specific_buffer_size is not None else receive_buffer_size
         with sock_receive_lock:
             received_bytes = sock.recv(size)
-            if not received_bytes:
-                raise ConnectionError(&#34;Connection is closed&#34;)
             if all_message_trace_enabled:
                 logger.debug(f&#34;Received bytes: {received_bytes}&#34;)
             return received_bytes

diff --git a/docs/api-docs/slack_sdk/version.html b/docs/api-docs/slack_sdk/version.html
@@ -28,7 +28,7 @@ <h1 class="title">Module <code>slack_sdk.version</code></h1>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;Check the latest version at https://pypi.org/project/slack-sdk/&#34;&#34;&#34;
-__version__ = &#34;3.18.3&#34;</code></pre>
+__version__ = &#34;3.18.4&#34;</code></pre>
 </details>
 </section>
 <section>

diff --git a/docs/api-docs/slack_sdk/web/async_base_client.html b/docs/api-docs/slack_sdk/web/async_base_client.html
@@ -48,7 +48,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_base_client</code></h1>
 from ..proxy_env_variable_loader import load_http_proxy_from_env
 
 from slack_sdk.http_retry.builtin_async_handlers import async_default_handlers
-from slack_sdk.http_retry.handler import RetryHandler
+from slack_sdk.http_retry.async_handler import AsyncRetryHandler
 
 
 class AsyncBaseClient:
@@ -69,7 +69,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_base_client</code></h1>
         # for Org-Wide App installation
         team_id: Optional[str] = None,
         logger: Optional[logging.Logger] = None,
-        retry_handlers: Optional[List[RetryHandler]] = None,
+        retry_handlers: Optional[List[AsyncRetryHandler]] = None,
     ):
         self.token = None if token is None else token.strip()
         &#34;&#34;&#34;A string specifying an `xoxp-*` or `xoxb-*` token.&#34;&#34;&#34;
@@ -255,7 +255,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="slack_sdk.web.async_base_client.AsyncBaseClient"><code class="flex name class">
 <span>class <span class="ident">AsyncBaseClient</span></span>
-<span>(</span><span>token: Optional[str] = None, base_url: str = 'https://www.slack.com/api/', timeout: int = 30, ssl: Optional[ssl.SSLContext] = None, proxy: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None, trust_env_in_session: bool = False, headers: Optional[dict] = None, user_agent_prefix: Optional[str] = None, user_agent_suffix: Optional[str] = None, team_id: Optional[str] = None, logger: Optional[logging.Logger] = None, retry_handlers: Optional[List[<a title="slack_sdk.http_retry.handler.RetryHandler" href="../http_retry/handler.html#slack_sdk.http_retry.handler.RetryHandler">RetryHandler</a>]] = None)</span>
+<span>(</span><span>token: Optional[str] = None, base_url: str = 'https://www.slack.com/api/', timeout: int = 30, ssl: Optional[ssl.SSLContext] = None, proxy: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None, trust_env_in_session: bool = False, headers: Optional[dict] = None, user_agent_prefix: Optional[str] = None, user_agent_suffix: Optional[str] = None, team_id: Optional[str] = None, logger: Optional[logging.Logger] = None, retry_handlers: Optional[List[slack_sdk.http_retry.async_handler.AsyncRetryHandler]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -281,7 +281,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         # for Org-Wide App installation
         team_id: Optional[str] = None,
         logger: Optional[logging.Logger] = None,
-        retry_handlers: Optional[List[RetryHandler]] = None,
+        retry_handlers: Optional[List[AsyncRetryHandler]] = None,
     ):
         self.token = None if token is None else token.strip()
         &#34;&#34;&#34;A string specifying an `xoxp-*` or `xoxb-*` token.&#34;&#34;&#34;

diff --git a/docs/api-docs/slack_sdk/web/async_client.html b/docs/api-docs/slack_sdk/web/async_client.html
@@ -2577,6 +2577,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
         ts: str,
         cursor: Optional[str] = None,
         inclusive: Optional[bool] = None,
+        include_all_metadata: Optional[bool] = None,
         latest: Optional[str] = None,
         limit: Optional[int] = None,
         oldest: Optional[str] = None,
@@ -2591,6 +2592,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
                 &#34;ts&#34;: ts,
                 &#34;cursor&#34;: cursor,
                 &#34;inclusive&#34;: inclusive,
+                &#34;include_all_metadata&#34;: include_all_metadata,
                 &#34;limit&#34;: limit,
                 &#34;latest&#34;: latest,
                 &#34;oldest&#34;: oldest,
@@ -4460,7 +4462,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="slack_sdk.web.async_client.AsyncWebClient"><code class="flex name class">
 <span>class <span class="ident">AsyncWebClient</span></span>
-<span>(</span><span>token: Optional[str] = None, base_url: str = 'https://www.slack.com/api/', timeout: int = 30, ssl: Optional[ssl.SSLContext] = None, proxy: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None, trust_env_in_session: bool = False, headers: Optional[dict] = None, user_agent_prefix: Optional[str] = None, user_agent_suffix: Optional[str] = None, team_id: Optional[str] = None, logger: Optional[logging.Logger] = None, retry_handlers: Optional[List[<a title="slack_sdk.http_retry.handler.RetryHandler" href="../http_retry/handler.html#slack_sdk.http_retry.handler.RetryHandler">RetryHandler</a>]] = None)</span>
+<span>(</span><span>token: Optional[str] = None, base_url: str = 'https://www.slack.com/api/', timeout: int = 30, ssl: Optional[ssl.SSLContext] = None, proxy: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None, trust_env_in_session: bool = False, headers: Optional[dict] = None, user_agent_prefix: Optional[str] = None, user_agent_suffix: Optional[str] = None, team_id: Optional[str] = None, logger: Optional[logging.Logger] = None, retry_handlers: Optional[List[slack_sdk.http_retry.async_handler.AsyncRetryHandler]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>A WebClient allows apps to communicate with the Slack Platform's Web API.</p>
@@ -7046,6 +7048,7 @@ <h2 id="note">Note</h2>
         ts: str,
         cursor: Optional[str] = None,
         inclusive: Optional[bool] = None,
+        include_all_metadata: Optional[bool] = None,
         latest: Optional[str] = None,
         limit: Optional[int] = None,
         oldest: Optional[str] = None,
@@ -7060,6 +7063,7 @@ <h2 id="note">Note</h2>
                 &#34;ts&#34;: ts,
                 &#34;cursor&#34;: cursor,
                 &#34;inclusive&#34;: inclusive,
+                &#34;include_all_metadata&#34;: include_all_metadata,
                 &#34;limit&#34;: limit,
                 &#34;latest&#34;: latest,
                 &#34;oldest&#34;: oldest,
@@ -12883,7 +12887,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="slack_sdk.web.async_client.AsyncWebClient.conversations_replies"><code class="name flex">
-<span>async def <span class="ident">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = None, **kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
+<span>async def <span class="ident">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, include_all_metadata: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = None, **kwargs) ‑> <a title="slack_sdk.web.async_slack_response.AsyncSlackResponse" href="async_slack_response.html#slack_sdk.web.async_slack_response.AsyncSlackResponse">AsyncSlackResponse</a></span>
 </code></dt>
 <dd>
 <div class="desc"><p>Retrieve a thread of messages posted to a conversation
@@ -12899,6 +12903,7 @@ <h3>Methods</h3>
     ts: str,
     cursor: Optional[str] = None,
     inclusive: Optional[bool] = None,
+    include_all_metadata: Optional[bool] = None,
     latest: Optional[str] = None,
     limit: Optional[int] = None,
     oldest: Optional[str] = None,
@@ -12913,6 +12918,7 @@ <h3>Methods</h3>
             &#34;ts&#34;: ts,
             &#34;cursor&#34;: cursor,
             &#34;inclusive&#34;: inclusive,
+            &#34;include_all_metadata&#34;: include_all_metadata,
             &#34;limit&#34;: limit,
             &#34;latest&#34;: latest,
             &#34;oldest&#34;: oldest,

diff --git a/docs/api-docs/slack_sdk/web/client.html b/docs/api-docs/slack_sdk/web/client.html
@@ -2568,6 +2568,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
         ts: str,
         cursor: Optional[str] = None,
         inclusive: Optional[bool] = None,
+        include_all_metadata: Optional[bool] = None,
         latest: Optional[str] = None,
         limit: Optional[int] = None,
         oldest: Optional[str] = None,
@@ -2582,6 +2583,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
                 &#34;ts&#34;: ts,
                 &#34;cursor&#34;: cursor,
                 &#34;inclusive&#34;: inclusive,
+                &#34;include_all_metadata&#34;: include_all_metadata,
                 &#34;limit&#34;: limit,
                 &#34;latest&#34;: latest,
                 &#34;oldest&#34;: oldest,
@@ -7037,6 +7039,7 @@ <h2 id="note">Note</h2>
         ts: str,
         cursor: Optional[str] = None,
         inclusive: Optional[bool] = None,
+        include_all_metadata: Optional[bool] = None,
         latest: Optional[str] = None,
         limit: Optional[int] = None,
         oldest: Optional[str] = None,
@@ -7051,6 +7054,7 @@ <h2 id="note">Note</h2>
                 &#34;ts&#34;: ts,
                 &#34;cursor&#34;: cursor,
                 &#34;inclusive&#34;: inclusive,
+                &#34;include_all_metadata&#34;: include_all_metadata,
                 &#34;limit&#34;: limit,
                 &#34;latest&#34;: latest,
                 &#34;oldest&#34;: oldest,
@@ -12874,7 +12878,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="slack_sdk.web.client.WebClient.conversations_replies"><code class="name flex">
-<span>def <span class="ident">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = None, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
+<span>def <span class="ident">conversations_replies</span></span>(<span>self, *, channel: str, ts: str, cursor: Optional[str] = None, inclusive: Optional[bool] = None, include_all_metadata: Optional[bool] = None, latest: Optional[str] = None, limit: Optional[int] = None, oldest: Optional[str] = None, **kwargs) ‑> <a title="slack_sdk.web.slack_response.SlackResponse" href="slack_response.html#slack_sdk.web.slack_response.SlackResponse">SlackResponse</a></span>
 </code></dt>
 <dd>
 <div class="desc"><p>Retrieve a thread of messages posted to a conversation
@@ -12890,6 +12894,7 @@ <h3>Methods</h3>
     ts: str,
     cursor: Optional[str] = None,
     inclusive: Optional[bool] = None,
+    include_all_metadata: Optional[bool] = None,
     latest: Optional[str] = None,
     limit: Optional[int] = None,
     oldest: Optional[str] = None,
@@ -12904,6 +12909,7 @@ <h3>Methods</h3>
             &#34;ts&#34;: ts,
             &#34;cursor&#34;: cursor,
             &#34;inclusive&#34;: inclusive,
+            &#34;include_all_metadata&#34;: include_all_metadata,
             &#34;limit&#34;: limit,
             &#34;latest&#34;: latest,
             &#34;oldest&#34;: oldest,