Skip to content

Commit 46ece5e

Browse files
seratchseratch
committed
Generate api-docs
1 parent e871811 commit 46ece5e

File tree

7 files changed

+37
-23
lines changed

7 files changed

+37
-23
lines changed

‎docs/api-docs/slack_sdk/index.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2360,7 +2360,7 @@ <h2 id="note">Note</h2>
23602360
ts: Optional[str] = None,
23612361
source: Optional[str] = None,
23622362
unfurl_id: Optional[str] = None,
2363-
unfurls: Dict[str, Dict],
2363+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
23642364
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
23652365
user_auth_message: Optional[str] = None,
23662366
user_auth_required: Optional[bool] = None,
@@ -2383,6 +2383,7 @@ <h2 id="note">Note</h2>
23832383
&#34;user_auth_url&#34;: user_auth_url,
23842384
}
23852385
)
2386+
_parse_web_class_objects(kwargs) # for user_auth_blocks
23862387
kwargs = _remove_none_values(kwargs)
23872388
# NOTE: intentionally using json over params for API methods using blocks/attachments
23882389
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -8162,7 +8163,7 @@ <h3>Methods</h3>
81628163
</details>
81638164
</dd>
81648165
<dt id="slack_sdk.WebClient.chat_unfurl"><code class="name flex">
8165-
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Dict[str, Dict], user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
8166+
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Optional[Dict[str, Dict]] = None, user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
81668167
</code></dt>
81678168
<dd>
81688169
<div class="desc"><p>Provide custom unfurl behavior for user-posted URLs.
@@ -8178,7 +8179,7 @@ <h3>Methods</h3>
81788179
ts: Optional[str] = None,
81798180
source: Optional[str] = None,
81808181
unfurl_id: Optional[str] = None,
8181-
unfurls: Dict[str, Dict],
8182+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
81828183
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
81838184
user_auth_message: Optional[str] = None,
81848185
user_auth_required: Optional[bool] = None,
@@ -8201,6 +8202,7 @@ <h3>Methods</h3>
82018202
&#34;user_auth_url&#34;: user_auth_url,
82028203
}
82038204
)
8205+
_parse_web_class_objects(kwargs) # for user_auth_blocks
82048206
kwargs = _remove_none_values(kwargs)
82058207
# NOTE: intentionally using json over params for API methods using blocks/attachments
82068208
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)</code></pre>

‎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.19.3&#34;</code></pre>
31+
__version__ = &#34;3.19.4&#34;</code></pre>
3232
</details>
3333
</section>
3434
<section>

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2160,7 +2160,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
21602160
ts: Optional[str] = None,
21612161
source: Optional[str] = None,
21622162
unfurl_id: Optional[str] = None,
2163-
unfurls: Dict[str, Dict],
2163+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
21642164
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
21652165
user_auth_message: Optional[str] = None,
21662166
user_auth_required: Optional[bool] = None,
@@ -2183,6 +2183,7 @@ <h1 class="title">Module <code>slack_sdk.web.async_client</code></h1>
21832183
&#34;user_auth_url&#34;: user_auth_url,
21842184
}
21852185
)
2186+
_parse_web_class_objects(kwargs) # for user_auth_blocks
21862187
kwargs = _remove_none_values(kwargs)
21872188
# NOTE: intentionally using json over params for API methods using blocks/attachments
21882189
return await self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -6800,7 +6801,7 @@ <h2 id="note">Note</h2>
68006801
ts: Optional[str] = None,
68016802
source: Optional[str] = None,
68026803
unfurl_id: Optional[str] = None,
6803-
unfurls: Dict[str, Dict],
6804+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
68046805
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
68056806
user_auth_message: Optional[str] = None,
68066807
user_auth_required: Optional[bool] = None,
@@ -6823,6 +6824,7 @@ <h2 id="note">Note</h2>
68236824
&#34;user_auth_url&#34;: user_auth_url,
68246825
}
68256826
)
6827+
_parse_web_class_objects(kwargs) # for user_auth_blocks
68266828
kwargs = _remove_none_values(kwargs)
68276829
# NOTE: intentionally using json over params for API methods using blocks/attachments
68286830
return await self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -12602,7 +12604,7 @@ <h3>Methods</h3>
1260212604
</details>
1260312605
</dd>
1260412606
<dt id="slack_sdk.web.async_client.AsyncWebClient.chat_unfurl"><code class="name flex">
12605-
<span>async def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Dict[str, Dict], user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
12607+
<span>async def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Optional[Dict[str, Dict]] = None, user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
1260612608
</code></dt>
1260712609
<dd>
1260812610
<div class="desc"><p>Provide custom unfurl behavior for user-posted URLs.
@@ -12618,7 +12620,7 @@ <h3>Methods</h3>
1261812620
ts: Optional[str] = None,
1261912621
source: Optional[str] = None,
1262012622
unfurl_id: Optional[str] = None,
12621-
unfurls: Dict[str, Dict],
12623+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
1262212624
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
1262312625
user_auth_message: Optional[str] = None,
1262412626
user_auth_required: Optional[bool] = None,
@@ -12641,6 +12643,7 @@ <h3>Methods</h3>
1264112643
&#34;user_auth_url&#34;: user_auth_url,
1264212644
}
1264312645
)
12646+
_parse_web_class_objects(kwargs) # for user_auth_blocks
1264412647
kwargs = _remove_none_values(kwargs)
1264512648
# NOTE: intentionally using json over params for API methods using blocks/attachments
1264612649
return await self.api_call(&#34;chat.unfurl&#34;, json=kwargs)</code></pre>

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2151,7 +2151,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
21512151
ts: Optional[str] = None,
21522152
source: Optional[str] = None,
21532153
unfurl_id: Optional[str] = None,
2154-
unfurls: Dict[str, Dict],
2154+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
21552155
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
21562156
user_auth_message: Optional[str] = None,
21572157
user_auth_required: Optional[bool] = None,
@@ -2174,6 +2174,7 @@ <h1 class="title">Module <code>slack_sdk.web.client</code></h1>
21742174
&#34;user_auth_url&#34;: user_auth_url,
21752175
}
21762176
)
2177+
_parse_web_class_objects(kwargs) # for user_auth_blocks
21772178
kwargs = _remove_none_values(kwargs)
21782179
# NOTE: intentionally using json over params for API methods using blocks/attachments
21792180
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -6791,7 +6792,7 @@ <h2 id="note">Note</h2>
67916792
ts: Optional[str] = None,
67926793
source: Optional[str] = None,
67936794
unfurl_id: Optional[str] = None,
6794-
unfurls: Dict[str, Dict],
6795+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
67956796
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
67966797
user_auth_message: Optional[str] = None,
67976798
user_auth_required: Optional[bool] = None,
@@ -6814,6 +6815,7 @@ <h2 id="note">Note</h2>
68146815
&#34;user_auth_url&#34;: user_auth_url,
68156816
}
68166817
)
6818+
_parse_web_class_objects(kwargs) # for user_auth_blocks
68176819
kwargs = _remove_none_values(kwargs)
68186820
# NOTE: intentionally using json over params for API methods using blocks/attachments
68196821
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -12593,7 +12595,7 @@ <h3>Methods</h3>
1259312595
</details>
1259412596
</dd>
1259512597
<dt id="slack_sdk.web.client.WebClient.chat_unfurl"><code class="name flex">
12596-
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Dict[str, Dict], user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
12598+
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Optional[Dict[str, Dict]] = None, user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
1259712599
</code></dt>
1259812600
<dd>
1259912601
<div class="desc"><p>Provide custom unfurl behavior for user-posted URLs.
@@ -12609,7 +12611,7 @@ <h3>Methods</h3>
1260912611
ts: Optional[str] = None,
1261012612
source: Optional[str] = None,
1261112613
unfurl_id: Optional[str] = None,
12612-
unfurls: Dict[str, Dict],
12614+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
1261312615
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
1261412616
user_auth_message: Optional[str] = None,
1261512617
user_auth_required: Optional[bool] = None,
@@ -12632,6 +12634,7 @@ <h3>Methods</h3>
1263212634
&#34;user_auth_url&#34;: user_auth_url,
1263312635
}
1263412636
)
12637+
_parse_web_class_objects(kwargs) # for user_auth_blocks
1263512638
kwargs = _remove_none_values(kwargs)
1263612639
# NOTE: intentionally using json over params for API methods using blocks/attachments
1263712640
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)</code></pre>

‎docs/api-docs/slack_sdk/web/index.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2571,7 +2571,7 @@ <h2 id="note">Note</h2>
25712571
ts: Optional[str] = None,
25722572
source: Optional[str] = None,
25732573
unfurl_id: Optional[str] = None,
2574-
unfurls: Dict[str, Dict],
2574+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
25752575
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
25762576
user_auth_message: Optional[str] = None,
25772577
user_auth_required: Optional[bool] = None,
@@ -2594,6 +2594,7 @@ <h2 id="note">Note</h2>
25942594
&#34;user_auth_url&#34;: user_auth_url,
25952595
}
25962596
)
2597+
_parse_web_class_objects(kwargs) # for user_auth_blocks
25972598
kwargs = _remove_none_values(kwargs)
25982599
# NOTE: intentionally using json over params for API methods using blocks/attachments
25992600
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)
@@ -8373,7 +8374,7 @@ <h3>Methods</h3>
83738374
</details>
83748375
</dd>
83758376
<dt id="slack_sdk.web.WebClient.chat_unfurl"><code class="name flex">
8376-
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Dict[str, Dict], user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
8377+
<span>def <span class="ident">chat_unfurl</span></span>(<span>self, *, channel: Optional[str] = None, ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, unfurls: Optional[Dict[str, Dict]] = None, user_auth_blocks: Union[str, Sequence[Union[Dict, <a title="slack_sdk.models.blocks.blocks.Block" href="../models/blocks/blocks.html#slack_sdk.models.blocks.blocks.Block">Block</a>]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: 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>
83778378
</code></dt>
83788379
<dd>
83798380
<div class="desc"><p>Provide custom unfurl behavior for user-posted URLs.
@@ -8389,7 +8390,7 @@ <h3>Methods</h3>
83898390
ts: Optional[str] = None,
83908391
source: Optional[str] = None,
83918392
unfurl_id: Optional[str] = None,
8392-
unfurls: Dict[str, Dict],
8393+
unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_*
83938394
user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
83948395
user_auth_message: Optional[str] = None,
83958396
user_auth_required: Optional[bool] = None,
@@ -8412,6 +8413,7 @@ <h3>Methods</h3>
84128413
&#34;user_auth_url&#34;: user_auth_url,
84138414
}
84148415
)
8416+
_parse_web_class_objects(kwargs) # for user_auth_blocks
84158417
kwargs = _remove_none_values(kwargs)
84168418
# NOTE: intentionally using json over params for API methods using blocks/attachments
84178419
return self.api_call(&#34;chat.unfurl&#34;, json=kwargs)</code></pre>

‎docs/api-docs/slack_sdk/web/internal_utils.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,11 @@ <h1 class="title">Module <code>slack_sdk.web.internal_utils</code></h1>
222222
return obj.to_dict()
223223
return obj
224224

225-
blocks = kwargs.get(&#34;blocks&#34;, None)
226-
if blocks is not None and isinstance(blocks, Sequence) and (not isinstance(blocks, str)):
227-
dict_blocks = [to_dict(b) for b in blocks]
228-
kwargs.update({&#34;blocks&#34;: dict_blocks})
225+
for blocks_name in [&#34;blocks&#34;, &#34;user_auth_blocks&#34;]:
226+
blocks = kwargs.get(blocks_name, None)
227+
if blocks is not None and isinstance(blocks, Sequence) and (not isinstance(blocks, str)):
228+
dict_blocks = [to_dict(b) for b in blocks]
229+
kwargs.update({blocks_name: dict_blocks})
229230

230231
attachments = kwargs.get(&#34;attachments&#34;, None)
231232
if attachments is not None and isinstance(attachments, Sequence) and (not isinstance(attachments, str)):

0 commit comments

Comments
 (0)