From 46ece5e16c152022a27502d9df47e72b20cb03f6 Mon Sep 17 00:00:00 2001 From: Kazuhiro Sera Date: Thu, 17 Nov 2022 10:59:01 +0900 Subject: [PATCH] Generate api-docs --- docs/api-docs/slack_sdk/index.html | 8 +++++--- docs/api-docs/slack_sdk/version.html | 2 +- docs/api-docs/slack_sdk/web/async_client.html | 11 +++++++---- docs/api-docs/slack_sdk/web/client.html | 11 +++++++---- docs/api-docs/slack_sdk/web/index.html | 8 +++++--- docs/api-docs/slack_sdk/web/internal_utils.html | 9 +++++---- docs/api-docs/slack_sdk/web/legacy_client.html | 11 +++++++---- 7 files changed, 37 insertions(+), 23 deletions(-) diff --git a/docs/api-docs/slack_sdk/index.html b/docs/api-docs/slack_sdk/index.html index 54542e503..7c4cfad4a 100644 --- a/docs/api-docs/slack_sdk/index.html +++ b/docs/api-docs/slack_sdk/index.html @@ -2360,7 +2360,7 @@

Note

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -2383,6 +2383,7 @@

Note

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -8162,7 +8163,7 @@

Methods

-def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse +def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse

Provide custom unfurl behavior for user-posted URLs. @@ -8178,7 +8179,7 @@

Methods

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -8201,6 +8202,7 @@

Methods

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) diff --git a/docs/api-docs/slack_sdk/version.html b/docs/api-docs/slack_sdk/version.html index 258b0bbd5..7ca280091 100644 --- a/docs/api-docs/slack_sdk/version.html +++ b/docs/api-docs/slack_sdk/version.html @@ -28,7 +28,7 @@

Module slack_sdk.version

Expand source code 
"""Check the latest version at https://pypi.org/project/slack-sdk/"""
-__version__ = "3.19.3"
+__version__ = "3.19.4"
diff --git a/docs/api-docs/slack_sdk/web/async_client.html b/docs/api-docs/slack_sdk/web/async_client.html index 16209d258..7d597a38c 100644 --- a/docs/api-docs/slack_sdk/web/async_client.html +++ b/docs/api-docs/slack_sdk/web/async_client.html @@ -2160,7 +2160,7 @@

Module slack_sdk.web.async_client

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -2183,6 +2183,7 @@

Module slack_sdk.web.async_client

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return await self.api_call("chat.unfurl", json=kwargs) @@ -6800,7 +6801,7 @@

Note

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -6823,6 +6824,7 @@

Note

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return await self.api_call("chat.unfurl", json=kwargs) @@ -12602,7 +12604,7 @@

Methods

-async def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> AsyncSlackResponse +async def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> AsyncSlackResponse

Provide custom unfurl behavior for user-posted URLs. @@ -12618,7 +12620,7 @@

Methods

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -12641,6 +12643,7 @@

Methods

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return await self.api_call("chat.unfurl", json=kwargs) diff --git a/docs/api-docs/slack_sdk/web/client.html b/docs/api-docs/slack_sdk/web/client.html index ef022b6a2..44d7c968d 100644 --- a/docs/api-docs/slack_sdk/web/client.html +++ b/docs/api-docs/slack_sdk/web/client.html @@ -2151,7 +2151,7 @@

Module slack_sdk.web.client

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -2174,6 +2174,7 @@

Module slack_sdk.web.client

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -6791,7 +6792,7 @@

Note

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -6814,6 +6815,7 @@

Note

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -12593,7 +12595,7 @@

Methods

-def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse +def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse

Provide custom unfurl behavior for user-posted URLs. @@ -12609,7 +12611,7 @@

Methods

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -12632,6 +12634,7 @@

Methods

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) diff --git a/docs/api-docs/slack_sdk/web/index.html b/docs/api-docs/slack_sdk/web/index.html index e00d40561..08bf0a7fd 100644 --- a/docs/api-docs/slack_sdk/web/index.html +++ b/docs/api-docs/slack_sdk/web/index.html @@ -2571,7 +2571,7 @@

Note

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -2594,6 +2594,7 @@

Note

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -8373,7 +8374,7 @@

Methods

-def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse +def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> SlackResponse

Provide custom unfurl behavior for user-posted URLs. @@ -8389,7 +8390,7 @@

Methods

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -8412,6 +8413,7 @@

Methods

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) diff --git a/docs/api-docs/slack_sdk/web/internal_utils.html b/docs/api-docs/slack_sdk/web/internal_utils.html index f1f70a0e2..6f9e064d0 100644 --- a/docs/api-docs/slack_sdk/web/internal_utils.html +++ b/docs/api-docs/slack_sdk/web/internal_utils.html @@ -222,10 +222,11 @@

Module slack_sdk.web.internal_utils

return obj.to_dict() return obj - blocks = kwargs.get("blocks", None) - if blocks is not None and isinstance(blocks, Sequence) and (not isinstance(blocks, str)): - dict_blocks = [to_dict(b) for b in blocks] - kwargs.update({"blocks": dict_blocks}) + for blocks_name in ["blocks", "user_auth_blocks"]: + blocks = kwargs.get(blocks_name, None) + if blocks is not None and isinstance(blocks, Sequence) and (not isinstance(blocks, str)): + dict_blocks = [to_dict(b) for b in blocks] + kwargs.update({blocks_name: dict_blocks}) attachments = kwargs.get("attachments", None) if attachments is not None and isinstance(attachments, Sequence) and (not isinstance(attachments, str)): diff --git a/docs/api-docs/slack_sdk/web/legacy_client.html b/docs/api-docs/slack_sdk/web/legacy_client.html index 44f794686..4cf37e6e2 100644 --- a/docs/api-docs/slack_sdk/web/legacy_client.html +++ b/docs/api-docs/slack_sdk/web/legacy_client.html @@ -2161,7 +2161,7 @@

Module slack_sdk.web.legacy_client

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -2184,6 +2184,7 @@

Module slack_sdk.web.legacy_client

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -6801,7 +6802,7 @@

Note

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -6824,6 +6825,7 @@

Note

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs) @@ -12603,7 +12605,7 @@

Methods

-def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> Union[_asyncio.Future, LegacySlackResponse] +def chat_unfurl(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, Block]], ForwardRef(None)] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, user_auth_url: Optional[str] = None, **kwargs) ‑> Union[_asyncio.Future, LegacySlackResponse]

Provide custom unfurl behavior for user-posted URLs. @@ -12619,7 +12621,7 @@

Methods

ts: Optional[str] = None, source: Optional[str] = None, unfurl_id: Optional[str] = None, - unfurls: Dict[str, Dict], + unfurls: Optional[Dict[str, Dict]] = None, # or user_auth_* user_auth_blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None, user_auth_message: Optional[str] = None, user_auth_required: Optional[bool] = None, @@ -12642,6 +12644,7 @@

Methods

"user_auth_url": user_auth_url, } ) + _parse_web_class_objects(kwargs) # for user_auth_blocks kwargs = _remove_none_values(kwargs) # NOTE: intentionally using json over params for API methods using blocks/attachments return self.api_call("chat.unfurl", json=kwargs)