Skip to content

Commit d558afa

Browse files
committed
Run ./scripts/generate_api_docs.sh
1 parent a564459 commit d558afa

File tree

9 files changed

+44
-14
lines changed

9 files changed

+44
-14
lines changed

docs/api-docs/slack_sdk/index.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2783,6 +2783,7 @@ <h2 id="note">Note</h2>
27832783
ts: str,
27842784
cursor: Optional[str] = None,
27852785
inclusive: Optional[bool] = None,
2786+
include_all_metadata: Optional[bool] = None,
27862787
latest: Optional[str] = None,
27872788
limit: Optional[int] = None,
27882789
oldest: Optional[str] = None,
@@ -2797,6 +2798,7 @@ <h2 id="note">Note</h2>
27972798
&#34;ts&#34;: ts,
27982799
&#34;cursor&#34;: cursor,
27992800
&#34;inclusive&#34;: inclusive,
2801+
&#34;include_all_metadata&#34;: include_all_metadata,
28002802
&#34;limit&#34;: limit,
28012803
&#34;latest&#34;: latest,
28022804
&#34;oldest&#34;: oldest,
@@ -8620,7 +8622,7 @@ <h3>Methods</h3>
86208622
</details>
86218623
</dd>
86228624
<dt id="slack_sdk.WebClient.conversations_replies"><code class="name flex">
8623-
<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>
8625+
<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>
86248626
</code></dt>
86258627
<dd>
86268628
<div class="desc"><p>Retrieve a thread of messages posted to a conversation
@@ -8636,6 +8638,7 @@ <h3>Methods</h3>
86368638
ts: str,
86378639
cursor: Optional[str] = None,
86388640
inclusive: Optional[bool] = None,
8641+
include_all_metadata: Optional[bool] = None,
86398642
latest: Optional[str] = None,
86408643
limit: Optional[int] = None,
86418644
oldest: Optional[str] = None,
@@ -8650,6 +8653,7 @@ <h3>Methods</h3>
86508653
&#34;ts&#34;: ts,
86518654
&#34;cursor&#34;: cursor,
86528655
&#34;inclusive&#34;: inclusive,
8656+
&#34;include_all_metadata&#34;: include_all_metadata,
86538657
&#34;limit&#34;: limit,
86548658
&#34;latest&#34;: latest,
86558659
&#34;oldest&#34;: oldest,

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
213213
&#34;type&#34;,
214214
&#34;value&#34;,
215215
&#34;selected_date&#34;,
216+
&#34;selected_time&#34;,
216217
&#34;selected_conversation&#34;,
217218
&#34;selected_channel&#34;,
218219
&#34;selected_user&#34;,
@@ -229,6 +230,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
229230
type: Optional[str] = None, # skipcq: PYL-W0622
230231
value: Optional[str] = None,
231232
selected_date: Optional[str] = None,
233+
selected_time: Optional[str] = None,
232234
selected_conversation: Optional[str] = None,
233235
selected_channel: Optional[str] = None,
234236
selected_user: Optional[str] = None,
@@ -241,6 +243,7 @@ <h1 class="title">Module <code>slack_sdk.models.views</code></h1>
241243
self.type = type
242244
self.value = value
243245
self.selected_date = selected_date
246+
self.selected_time = selected_time
244247
self.selected_conversation = selected_conversation
245248
self.selected_channel = selected_channel
246249
self.selected_user = selected_user
@@ -536,7 +539,7 @@ <h3>Inherited members</h3>
536539
</dd>
537540
<dt id="slack_sdk.models.views.ViewStateValue"><code class="flex name class">
538541
<span>class <span class="ident">ViewStateValue</span></span>
539-
<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>
542+
<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>
540543
</code></dt>
541544
<dd>
542545
<div class="desc"><p>The base class for JSON serializable class objects</p></div>
@@ -549,6 +552,7 @@ <h3>Inherited members</h3>
549552
&#34;type&#34;,
550553
&#34;value&#34;,
551554
&#34;selected_date&#34;,
555+
&#34;selected_time&#34;,
552556
&#34;selected_conversation&#34;,
553557
&#34;selected_channel&#34;,
554558
&#34;selected_user&#34;,
@@ -565,6 +569,7 @@ <h3>Inherited members</h3>
565569
type: Optional[str] = None, # skipcq: PYL-W0622
566570
value: Optional[str] = None,
567571
selected_date: Optional[str] = None,
572+
selected_time: Optional[str] = None,
568573
selected_conversation: Optional[str] = None,
569574
selected_channel: Optional[str] = None,
570575
selected_user: Optional[str] = None,
@@ -577,6 +582,7 @@ <h3>Inherited members</h3>
577582
self.type = type
578583
self.value = value
579584
self.selected_date = selected_date
585+
self.selected_time = selected_time
580586
self.selected_conversation = selected_conversation
581587
self.selected_channel = selected_channel
582588
self.selected_user = selected_user

docs/api-docs/slack_sdk/socket_mode/builtin/internals.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,6 @@ <h1 class="title">Module <code>slack_sdk.socket_mode.builtin.internals</code></h
232232
size = specific_buffer_size if specific_buffer_size is not None else receive_buffer_size
233233
with sock_receive_lock:
234234
received_bytes = sock.recv(size)
235-
if not received_bytes:
236-
raise ConnectionError(&#34;Connection is closed&#34;)
237235
if all_message_trace_enabled:
238236
logger.debug(f&#34;Received bytes: {received_bytes}&#34;)
239237
return received_bytes

docs/api-docs/slack_sdk/version.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h1 class="title">Module <code>slack_sdk.version</code></h1>
2828
<span>Expand source code</span>
2929
</summary>
3030
<pre><code class="python">&#34;&#34;&#34;Check the latest version at https://pypi.org/project/slack-sdk/&#34;&#34;&#34;
31-
__version__ = &#34;3.18.3&#34;</code></pre>
31+
__version__ = &#34;3.18.4&#34;</code></pre>
3232
</details>
3333
</section>
3434
<section>

docs/api-docs/slack_sdk/web/async_base_client.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_base_client</code></h1>
4848
from ..proxy_env_variable_loader import load_http_proxy_from_env
4949

5050
from slack_sdk.http_retry.builtin_async_handlers import async_default_handlers
51-
from slack_sdk.http_retry.handler import RetryHandler
51+
from slack_sdk.http_retry.async_handler import AsyncRetryHandler
5252

5353

5454
class AsyncBaseClient:
@@ -69,7 +69,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_base_client</code></h1>
6969
# for Org-Wide App installation
7070
team_id: Optional[str] = None,
7171
logger: Optional[logging.Logger] = None,
72-
retry_handlers: Optional[List[RetryHandler]] = None,
72+
retry_handlers: Optional[List[AsyncRetryHandler]] = None,
7373
):
7474
self.token = None if token is None else token.strip()
7575
&#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>
255255
<dl>
256256
<dt id="slack_sdk.web.async_base_client.AsyncBaseClient"><code class="flex name class">
257257
<span>class <span class="ident">AsyncBaseClient</span></span>
258-
<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>
258+
<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>
259259
</code></dt>
260260
<dd>
261261
<div class="desc"></div>
@@ -281,7 +281,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
281281
# for Org-Wide App installation
282282
team_id: Optional[str] = None,
283283
logger: Optional[logging.Logger] = None,
284-
retry_handlers: Optional[List[RetryHandler]] = None,
284+
retry_handlers: Optional[List[AsyncRetryHandler]] = None,
285285
):
286286
self.token = None if token is None else token.strip()
287287
&#34;&#34;&#34;A string specifying an `xoxp-*` or `xoxb-*` token.&#34;&#34;&#34;

docs/api-docs/slack_sdk/web/async_client.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2577,6 +2577,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
25772577
ts: str,
25782578
cursor: Optional[str] = None,
25792579
inclusive: Optional[bool] = None,
2580+
include_all_metadata: Optional[bool] = None,
25802581
latest: Optional[str] = None,
25812582
limit: Optional[int] = None,
25822583
oldest: Optional[str] = None,
@@ -2591,6 +2592,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
25912592
&#34;ts&#34;: ts,
25922593
&#34;cursor&#34;: cursor,
25932594
&#34;inclusive&#34;: inclusive,
2595+
&#34;include_all_metadata&#34;: include_all_metadata,
25942596
&#34;limit&#34;: limit,
25952597
&#34;latest&#34;: latest,
25962598
&#34;oldest&#34;: oldest,
@@ -4460,7 +4462,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
44604462
<dl>
44614463
<dt id="slack_sdk.web.async_client.AsyncWebClient"><code class="flex name class">
44624464
<span>class <span class="ident">AsyncWebClient</span></span>
4463-
<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>
4465+
<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>
44644466
</code></dt>
44654467
<dd>
44664468
<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>
70467048
ts: str,
70477049
cursor: Optional[str] = None,
70487050
inclusive: Optional[bool] = None,
7051+
include_all_metadata: Optional[bool] = None,
70497052
latest: Optional[str] = None,
70507053
limit: Optional[int] = None,
70517054
oldest: Optional[str] = None,
@@ -7060,6 +7063,7 @@ <h2 id="note">Note</h2>
70607063
&#34;ts&#34;: ts,
70617064
&#34;cursor&#34;: cursor,
70627065
&#34;inclusive&#34;: inclusive,
7066+
&#34;include_all_metadata&#34;: include_all_metadata,
70637067
&#34;limit&#34;: limit,
70647068
&#34;latest&#34;: latest,
70657069
&#34;oldest&#34;: oldest,
@@ -12883,7 +12887,7 @@ <h3>Methods</h3>
1288312887
</details>
1288412888
</dd>
1288512889
<dt id="slack_sdk.web.async_client.AsyncWebClient.conversations_replies"><code class="name flex">
12886-
<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>
12890+
<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>
1288712891
</code></dt>
1288812892
<dd>
1288912893
<div class="desc"><p>Retrieve a thread of messages posted to a conversation
@@ -12899,6 +12903,7 @@ <h3>Methods</h3>
1289912903
ts: str,
1290012904
cursor: Optional[str] = None,
1290112905
inclusive: Optional[bool] = None,
12906+
include_all_metadata: Optional[bool] = None,
1290212907
latest: Optional[str] = None,
1290312908
limit: Optional[int] = None,
1290412909
oldest: Optional[str] = None,
@@ -12913,6 +12918,7 @@ <h3>Methods</h3>
1291312918
&#34;ts&#34;: ts,
1291412919
&#34;cursor&#34;: cursor,
1291512920
&#34;inclusive&#34;: inclusive,
12921+
&#34;include_all_metadata&#34;: include_all_metadata,
1291612922
&#34;limit&#34;: limit,
1291712923
&#34;latest&#34;: latest,
1291812924
&#34;oldest&#34;: oldest,

docs/api-docs/slack_sdk/web/client.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2568,6 +2568,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
25682568
ts: str,
25692569
cursor: Optional[str] = None,
25702570
inclusive: Optional[bool] = None,
2571+
include_all_metadata: Optional[bool] = None,
25712572
latest: Optional[str] = None,
25722573
limit: Optional[int] = None,
25732574
oldest: Optional[str] = None,
@@ -2582,6 +2583,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
25822583
&#34;ts&#34;: ts,
25832584
&#34;cursor&#34;: cursor,
25842585
&#34;inclusive&#34;: inclusive,
2586+
&#34;include_all_metadata&#34;: include_all_metadata,
25852587
&#34;limit&#34;: limit,
25862588
&#34;latest&#34;: latest,
25872589
&#34;oldest&#34;: oldest,
@@ -7037,6 +7039,7 @@ <h2 id="note">Note</h2>
70377039
ts: str,
70387040
cursor: Optional[str] = None,
70397041
inclusive: Optional[bool] = None,
7042+
include_all_metadata: Optional[bool] = None,
70407043
latest: Optional[str] = None,
70417044
limit: Optional[int] = None,
70427045
oldest: Optional[str] = None,
@@ -7051,6 +7054,7 @@ <h2 id="note">Note</h2>
70517054
&#34;ts&#34;: ts,
70527055
&#34;cursor&#34;: cursor,
70537056
&#34;inclusive&#34;: inclusive,
7057+
&#34;include_all_metadata&#34;: include_all_metadata,
70547058
&#34;limit&#34;: limit,
70557059
&#34;latest&#34;: latest,
70567060
&#34;oldest&#34;: oldest,
@@ -12874,7 +12878,7 @@ <h3>Methods</h3>
1287412878
</details>
1287512879
</dd>
1287612880
<dt id="slack_sdk.web.client.WebClient.conversations_replies"><code class="name flex">
12877-
<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>
12881+
<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>
1287812882
</code></dt>
1287912883
<dd>
1288012884
<div class="desc"><p>Retrieve a thread of messages posted to a conversation
@@ -12890,6 +12894,7 @@ <h3>Methods</h3>
1289012894
ts: str,
1289112895
cursor: Optional[str] = None,
1289212896
inclusive: Optional[bool] = None,
12897+
include_all_metadata: Optional[bool] = None,
1289312898
latest: Optional[str] = None,
1289412899
limit: Optional[int] = None,
1289512900
oldest: Optional[str] = None,
@@ -12904,6 +12909,7 @@ <h3>Methods</h3>
1290412909
&#34;ts&#34;: ts,
1290512910
&#34;cursor&#34;: cursor,
1290612911
&#34;inclusive&#34;: inclusive,
12912+
&#34;include_all_metadata&#34;: include_all_metadata,
1290712913
&#34;limit&#34;: limit,
1290812914
&#34;latest&#34;: latest,
1290912915
&#34;oldest&#34;: oldest,

0 commit comments

Comments
 (0)