Skip to content

Commit 86f56e3

Browse files
srtaalejsrtaalej
committed
fix: strict typing for description_blocks
1 parent 8d44238 commit 86f56e3

3 files changed

Lines changed: 44 additions & 44 deletions

File tree

‎slack_sdk/web/async_client.py‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from slack_sdk.web.async_chat_stream import AsyncChatStream
2222

2323
from ..models.attachments import Attachment
24-
from ..models.blocks import Block
24+
from ..models.blocks import Block, RichTextBlock
2525
from ..models.metadata import Metadata
2626
from .async_base_client import AsyncBaseClient, AsyncSlackResponse
2727
from .internal_utils import (
@@ -4908,7 +4908,7 @@ async def slackLists_access_delete(
49084908
**kwargs,
49094909
) -> AsyncSlackResponse:
49104910
"""Revoke access to a List for specified entities.
4911-
https://docs.slack.dev/reference/methods/slacklists.access.delete
4911+
https://docs.slack.dev/reference/methods/slackLists.access.delete
49124912
"""
49134913
kwargs.update({"list_id": list_id, "channel_ids": channel_ids, "user_ids": user_ids})
49144914
kwargs = _remove_none_values(kwargs)
@@ -4924,7 +4924,7 @@ async def slackLists_access_set(
49244924
**kwargs,
49254925
) -> AsyncSlackResponse:
49264926
"""Set the access level to a List for specified entities.
4927-
https://docs.slack.dev/reference/methods/slacklists.access.set
4927+
https://docs.slack.dev/reference/methods/slackLists.access.set
49284928
"""
49294929
kwargs.update({"list_id": list_id, "access_level": access_level, "channel_ids": channel_ids, "user_ids": user_ids})
49304930
kwargs = _remove_none_values(kwargs)
@@ -4934,15 +4934,15 @@ async def slackLists_create(
49344934
self,
49354935
*,
49364936
name: str,
4937-
description_blocks: Optional[List[Dict[str, Any]]] = None,
4937+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
49384938
schema: Optional[List[Dict[str, Any]]] = None,
49394939
copy_from_list_id: Optional[str] = None,
49404940
include_copied_list_records: Optional[bool] = None,
49414941
todo_mode: Optional[bool] = None,
49424942
**kwargs,
49434943
) -> AsyncSlackResponse:
49444944
"""Creates a List.
4945-
https://docs.slack.dev/reference/methods/slacklists.create
4945+
https://docs.slack.dev/reference/methods/slackLists.create
49464946
"""
49474947
kwargs.update(
49484948
{
@@ -4965,7 +4965,7 @@ async def slackLists_download_get(
49654965
**kwargs,
49664966
) -> AsyncSlackResponse:
49674967
"""Retrieve List download URL from an export job to download List contents.
4968-
https://docs.slack.dev/reference/methods/slacklists.download.get
4968+
https://docs.slack.dev/reference/methods/slackLists.download.get
49694969
"""
49704970
kwargs.update(
49714971
{
@@ -4984,7 +4984,7 @@ async def slackLists_download_start(
49844984
**kwargs,
49854985
) -> AsyncSlackResponse:
49864986
"""Initiate a job to export List contents.
4987-
https://docs.slack.dev/reference/methods/slacklists.download.start
4987+
https://docs.slack.dev/reference/methods/slackLists.download.start
49884988
"""
49894989
kwargs.update(
49904990
{
@@ -5005,7 +5005,7 @@ async def slackLists_items_create(
50055005
**kwargs,
50065006
) -> AsyncSlackResponse:
50075007
"""Add a new item to an existing List.
5008-
https://docs.slack.dev/reference/methods/slacklists.items.create
5008+
https://docs.slack.dev/reference/methods/slackLists.items.create
50095009
"""
50105010
kwargs.update(
50115011
{
@@ -5026,7 +5026,7 @@ async def slackLists_items_delete(
50265026
**kwargs,
50275027
) -> AsyncSlackResponse:
50285028
"""Deletes an item from an existing List.
5029-
https://docs.slack.dev/reference/methods/slacklists.items.delete
5029+
https://docs.slack.dev/reference/methods/slackLists.items.delete
50305030
"""
50315031
kwargs.update(
50325032
{
@@ -5045,7 +5045,7 @@ async def slackLists_items_deleteMultiple(
50455045
**kwargs,
50465046
) -> AsyncSlackResponse:
50475047
"""Deletes multiple items from an existing List.
5048-
https://docs.slack.dev/reference/methods/slacklists.items.deletemultiple
5048+
https://docs.slack.dev/reference/methods/slackLists.items.deletemultiple
50495049
"""
50505050
kwargs.update(
50515051
{
@@ -5065,7 +5065,7 @@ async def slackLists_items_info(
50655065
**kwargs,
50665066
) -> AsyncSlackResponse:
50675067
"""Get a row from a List.
5068-
https://docs.slack.dev/reference/methods/slacklists.items.info
5068+
https://docs.slack.dev/reference/methods/slackLists.items.info
50695069
"""
50705070
kwargs.update(
50715071
{
@@ -5087,7 +5087,7 @@ async def slackLists_items_list(
50875087
**kwargs,
50885088
) -> AsyncSlackResponse:
50895089
"""Get records from a List.
5090-
https://docs.slack.dev/reference/methods/slacklists.items.list
5090+
https://docs.slack.dev/reference/methods/slackLists.items.list
50915091
"""
50925092
kwargs.update(
50935093
{
@@ -5108,7 +5108,7 @@ async def slackLists_items_update(
51085108
**kwargs,
51095109
) -> AsyncSlackResponse:
51105110
"""Updates cells in a List.
5111-
https://docs.slack.dev/reference/methods/slacklists.items.update
5111+
https://docs.slack.dev/reference/methods/slackLists.items.update
51125112
"""
51135113
kwargs.update(
51145114
{
@@ -5124,12 +5124,12 @@ async def slackLists_update(
51245124
*,
51255125
id: str,
51265126
name: Optional[str] = None,
5127-
description_blocks: Optional[List[Dict[str, Any]]] = None,
5127+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
51285128
todo_mode: Optional[bool] = None,
51295129
**kwargs,
51305130
) -> AsyncSlackResponse:
51315131
"""Update a List.
5132-
https://docs.slack.dev/reference/methods/slacklists.update
5132+
https://docs.slack.dev/reference/methods/slackLists.update
51335133
"""
51345134
kwargs.update(
51355135
{

‎slack_sdk/web/client.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from slack_sdk.web.chat_stream import ChatStream
1212

1313
from ..models.attachments import Attachment
14-
from ..models.blocks import Block
14+
from ..models.blocks import Block, RichTextBlock
1515
from ..models.metadata import Metadata
1616
from .base_client import BaseClient, SlackResponse
1717
from .internal_utils import (
@@ -4914,7 +4914,7 @@ def slackLists_access_set(
49144914
**kwargs,
49154915
) -> SlackResponse:
49164916
"""Set the access level to a List for specified entities.
4917-
https://docs.slack.dev/reference/methods/slacklists.access.set
4917+
https://docs.slack.dev/reference/methods/slackLists.access.set
49184918
"""
49194919
kwargs.update({"list_id": list_id, "access_level": access_level, "channel_ids": channel_ids, "user_ids": user_ids})
49204920
kwargs = _remove_none_values(kwargs)
@@ -4924,15 +4924,15 @@ def slackLists_create(
49244924
self,
49254925
*,
49264926
name: str,
4927-
description_blocks: Optional[List[Dict[str, Any]]] = None,
4927+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
49284928
schema: Optional[List[Dict[str, Any]]] = None,
49294929
copy_from_list_id: Optional[str] = None,
49304930
include_copied_list_records: Optional[bool] = None,
49314931
todo_mode: Optional[bool] = None,
49324932
**kwargs,
49334933
) -> SlackResponse:
49344934
"""Creates a List.
4935-
https://docs.slack.dev/reference/methods/slacklists.create
4935+
https://docs.slack.dev/reference/methods/slackLists.create
49364936
"""
49374937
kwargs.update(
49384938
{
@@ -4955,7 +4955,7 @@ def slackLists_download_get(
49554955
**kwargs,
49564956
) -> SlackResponse:
49574957
"""Retrieve List download URL from an export job to download List contents.
4958-
https://docs.slack.dev/reference/methods/slacklists.download.get
4958+
https://docs.slack.dev/reference/methods/slackLists.download.get
49594959
"""
49604960
kwargs.update(
49614961
{
@@ -4974,7 +4974,7 @@ def slackLists_download_start(
49744974
**kwargs,
49754975
) -> SlackResponse:
49764976
"""Initiate a job to export List contents.
4977-
https://docs.slack.dev/reference/methods/slacklists.download.start
4977+
https://docs.slack.dev/reference/methods/slackLists.download.start
49784978
"""
49794979
kwargs.update(
49804980
{
@@ -4995,7 +4995,7 @@ def slackLists_items_create(
49954995
**kwargs,
49964996
) -> SlackResponse:
49974997
"""Add a new item to an existing List.
4998-
https://docs.slack.dev/reference/methods/slacklists.items.create
4998+
https://docs.slack.dev/reference/methods/slackLists.items.create
49994999
"""
50005000
kwargs.update(
50015001
{
@@ -5016,7 +5016,7 @@ def slackLists_items_delete(
50165016
**kwargs,
50175017
) -> SlackResponse:
50185018
"""Deletes an item from an existing List.
5019-
https://docs.slack.dev/reference/methods/slacklists.items.delete
5019+
https://docs.slack.dev/reference/methods/slackLists.items.delete
50205020
"""
50215021
kwargs.update(
50225022
{
@@ -5035,7 +5035,7 @@ def slackLists_items_deleteMultiple(
50355035
**kwargs,
50365036
) -> SlackResponse:
50375037
"""Deletes multiple items from an existing List.
5038-
https://docs.slack.dev/reference/methods/slacklists.items.deletemultiple
5038+
https://docs.slack.dev/reference/methods/slackLists.items.deletemultiple
50395039
"""
50405040
kwargs.update(
50415041
{
@@ -5055,7 +5055,7 @@ def slackLists_items_info(
50555055
**kwargs,
50565056
) -> SlackResponse:
50575057
"""Get a row from a List.
5058-
https://docs.slack.dev/reference/methods/slacklists.items.info
5058+
https://docs.slack.dev/reference/methods/slackLists.items.info
50595059
"""
50605060
kwargs.update(
50615061
{
@@ -5077,7 +5077,7 @@ def slackLists_items_list(
50775077
**kwargs,
50785078
) -> SlackResponse:
50795079
"""Get records from a List.
5080-
https://docs.slack.dev/reference/methods/slacklists.items.list
5080+
https://docs.slack.dev/reference/methods/slackLists.items.list
50815081
"""
50825082
kwargs.update(
50835083
{
@@ -5098,7 +5098,7 @@ def slackLists_items_update(
50985098
**kwargs,
50995099
) -> SlackResponse:
51005100
"""Updates cells in a List.
5101-
https://docs.slack.dev/reference/methods/slacklists.items.update
5101+
https://docs.slack.dev/reference/methods/slackLists.items.update
51025102
"""
51035103
kwargs.update(
51045104
{
@@ -5114,12 +5114,12 @@ def slackLists_update(
51145114
*,
51155115
id: str,
51165116
name: Optional[str] = None,
5117-
description_blocks: Optional[List[Dict[str, Any]]] = None,
5117+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
51185118
todo_mode: Optional[bool] = None,
51195119
**kwargs,
51205120
) -> SlackResponse:
51215121
"""Update a List.
5122-
https://docs.slack.dev/reference/methods/slacklists.update
5122+
https://docs.slack.dev/reference/methods/slackLists.update
51235123
"""
51245124
kwargs.update(
51255125
{

‎slack_sdk/web/legacy_client.py‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
from slack_sdk.models.views import View
2323

2424
from ..models.attachments import Attachment
25-
from ..models.blocks import Block
25+
from ..models.blocks import Block, RichTextBlock
2626
from ..models.metadata import Metadata
2727
from .legacy_base_client import LegacyBaseClient, SlackResponse
2828
from .internal_utils import (
@@ -4846,7 +4846,7 @@ def slackLists_access_delete(
48464846
**kwargs,
48474847
) -> Union[Future, SlackResponse]:
48484848
"""Revoke access to a List for specified entities.
4849-
https://docs.slack.dev/reference/methods/slacklists.access.delete
4849+
https://docs.slack.dev/reference/methods/slackLists.access.delete
48504850
"""
48514851
kwargs.update({"list_id": list_id, "channel_ids": channel_ids, "user_ids": user_ids})
48524852
kwargs = _remove_none_values(kwargs)
@@ -4862,7 +4862,7 @@ def slackLists_access_set(
48624862
**kwargs,
48634863
) -> Union[Future, SlackResponse]:
48644864
"""Set the access level to a List for specified entities.
4865-
https://docs.slack.dev/reference/methods/slacklists.access.set
4865+
https://docs.slack.dev/reference/methods/slackLists.access.set
48664866
"""
48674867
kwargs.update({"list_id": list_id, "access_level": access_level, "channel_ids": channel_ids, "user_ids": user_ids})
48684868
kwargs = _remove_none_values(kwargs)
@@ -4872,15 +4872,15 @@ def slackLists_create(
48724872
self,
48734873
*,
48744874
name: str,
4875-
description_blocks: Optional[List[Dict[str, Any]]] = None,
4875+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
48764876
schema: Optional[List[Dict[str, Any]]] = None,
48774877
copy_from_list_id: Optional[str] = None,
48784878
include_copied_list_records: Optional[bool] = None,
48794879
todo_mode: Optional[bool] = None,
48804880
**kwargs,
48814881
) -> Union[Future, SlackResponse]:
48824882
"""Creates a List.
4883-
https://docs.slack.dev/reference/methods/slacklists.create
4883+
https://docs.slack.dev/reference/methods/slackLists.create
48844884
"""
48854885
kwargs.update(
48864886
{
@@ -4903,7 +4903,7 @@ def slackLists_download_get(
49034903
**kwargs,
49044904
) -> Union[Future, SlackResponse]:
49054905
"""Retrieve List download URL from an export job to download List contents.
4906-
https://docs.slack.dev/reference/methods/slacklists.download.get
4906+
https://docs.slack.dev/reference/methods/slackLists.download.get
49074907
"""
49084908
kwargs.update(
49094909
{
@@ -4922,7 +4922,7 @@ def slackLists_download_start(
49224922
**kwargs,
49234923
) -> Union[Future, SlackResponse]:
49244924
"""Initiate a job to export List contents.
4925-
https://docs.slack.dev/reference/methods/slacklists.download.start
4925+
https://docs.slack.dev/reference/methods/slackLists.download.start
49264926
"""
49274927
kwargs.update(
49284928
{
@@ -4943,7 +4943,7 @@ def slackLists_items_create(
49434943
**kwargs,
49444944
) -> Union[Future, SlackResponse]:
49454945
"""Add a new item to an existing List.
4946-
https://docs.slack.dev/reference/methods/slacklists.items.create
4946+
https://docs.slack.dev/reference/methods/slackLists.items.create
49474947
"""
49484948
kwargs.update(
49494949
{
@@ -4964,7 +4964,7 @@ def slackLists_items_delete(
49644964
**kwargs,
49654965
) -> Union[Future, SlackResponse]:
49664966
"""Deletes an item from an existing List.
4967-
https://docs.slack.dev/reference/methods/slacklists.items.delete
4967+
https://docs.slack.dev/reference/methods/slackLists.items.delete
49684968
"""
49694969
kwargs.update(
49704970
{
@@ -4983,7 +4983,7 @@ def slackLists_items_deleteMultiple(
49834983
**kwargs,
49844984
) -> Union[Future, SlackResponse]:
49854985
"""Deletes multiple items from an existing List.
4986-
https://docs.slack.dev/reference/methods/slacklists.items.deletemultiple
4986+
https://docs.slack.dev/reference/methods/slackLists.items.deletemultiple
49874987
"""
49884988
kwargs.update(
49894989
{
@@ -5003,7 +5003,7 @@ def slackLists_items_info(
50035003
**kwargs,
50045004
) -> Union[Future, SlackResponse]:
50055005
"""Get a row from a List.
5006-
https://docs.slack.dev/reference/methods/slacklists.items.info
5006+
https://docs.slack.dev/reference/methods/slackLists.items.info
50075007
"""
50085008
kwargs.update(
50095009
{
@@ -5025,7 +5025,7 @@ def slackLists_items_list(
50255025
**kwargs,
50265026
) -> Union[Future, SlackResponse]:
50275027
"""Get records from a List.
5028-
https://docs.slack.dev/reference/methods/slacklists.items.list
5028+
https://docs.slack.dev/reference/methods/slackLists.items.list
50295029
"""
50305030
kwargs.update(
50315031
{
@@ -5046,7 +5046,7 @@ def slackLists_items_update(
50465046
**kwargs,
50475047
) -> Union[Future, SlackResponse]:
50485048
"""Updates cells in a List.
5049-
https://docs.slack.dev/reference/methods/slacklists.items.update
5049+
https://docs.slack.dev/reference/methods/slackLists.items.update
50505050
"""
50515051
kwargs.update(
50525052
{
@@ -5062,12 +5062,12 @@ def slackLists_update(
50625062
*,
50635063
id: str,
50645064
name: Optional[str] = None,
5065-
description_blocks: Optional[List[Dict[str, Any]]] = None,
5065+
description_blocks: Optional[Union[str, Sequence[Union[Dict, RichTextBlock]]]] = None,
50665066
todo_mode: Optional[bool] = None,
50675067
**kwargs,
50685068
) -> Union[Future, SlackResponse]:
50695069
"""Update a List.
5070-
https://docs.slack.dev/reference/methods/slacklists.update
5070+
https://docs.slack.dev/reference/methods/slackLists.update
50715071
"""
50725072
kwargs.update(
50735073
{

0 commit comments

Comments
 (0)