fix(agent): match channel_id api argument for set_status and set_suggested_prompts

zimeg · zimeg · commit 1edf454723d6 · 2026-02-18T19:39:36.000-08:00
diff --git a/slack_bolt/agent/agent.py b/slack_bolt/agent/agent.py
@@ -77,7 +77,7 @@ def set_status(
         *,
         status: str,
         loading_messages: Optional[List[str]] = None,
-        channel: Optional[str] = None,
+        channel_id: Optional[str] = None,
         thread_ts: Optional[str] = None,
         **kwargs,
     ) -> SlackResponse:
@@ -86,15 +86,15 @@ def set_status(
         Args:
             status: The status text to display.
             loading_messages: Optional list of loading messages to cycle through.
-            channel: Channel ID. Defaults to the channel from the event context.
+            channel_id: Channel ID. Defaults to the channel from the event context.
             thread_ts: Thread timestamp. Defaults to the thread_ts from the event context.
             **kwargs: Additional arguments passed to ``WebClient.assistant_threads_setStatus()``.
 
         Returns:
             ``SlackResponse`` from the API call.
         """
         return self._client.assistant_threads_setStatus(
-            channel_id=channel or self._channel_id,  # type: ignore[arg-type]
+            channel_id=channel_id or self._channel_id,  # type: ignore[arg-type]
             thread_ts=thread_ts or self._thread_ts or self._ts,  # type: ignore[arg-type]
             status=status,
             loading_messages=loading_messages,
@@ -106,7 +106,7 @@ def set_suggested_prompts(
         *,
         prompts: Sequence[Union[str, Dict[str, str]]],
         title: Optional[str] = None,
-        channel: Optional[str] = None,
+        channel_id: Optional[str] = None,
         thread_ts: Optional[str] = None,
         **kwargs,
     ) -> SlackResponse:
@@ -116,7 +116,7 @@ def set_suggested_prompts(
             prompts: A sequence of prompts. Each prompt can be either a string
                 (used as both title and message) or a dict with 'title' and 'message' keys.
             title: Optional title for the suggested prompts section.
-            channel: Channel ID. Defaults to the channel from the event context.
+            channel_id: Channel ID. Defaults to the channel from the event context.
             thread_ts: Thread timestamp. Defaults to the thread_ts from the event context.
             **kwargs: Additional arguments passed to ``WebClient.assistant_threads_setSuggestedPrompts()``.
 
@@ -131,7 +131,7 @@ def set_suggested_prompts(
                 prompts_arg.append(prompt)
 
         return self._client.assistant_threads_setSuggestedPrompts(
-            channel_id=channel or self._channel_id,  # type: ignore[arg-type]
+            channel_id=channel_id or self._channel_id,  # type: ignore[arg-type]
             thread_ts=thread_ts or self._thread_ts or self._ts,  # type: ignore[arg-type]
             prompts=prompts_arg,
             title=title,
diff --git a/slack_bolt/agent/async_agent.py b/slack_bolt/agent/async_agent.py
@@ -76,7 +76,7 @@ async def set_status(
         *,
         status: str,
         loading_messages: Optional[List[str]] = None,
-        channel: Optional[str] = None,
+        channel_id: Optional[str] = None,
         thread_ts: Optional[str] = None,
         **kwargs,
     ) -> AsyncSlackResponse:
@@ -85,15 +85,15 @@ async def set_status(
         Args:
             status: The status text to display.
             loading_messages: Optional list of loading messages to cycle through.
-            channel: Channel ID. Defaults to the channel from the event context.
+            channel_id: Channel ID. Defaults to the channel from the event context.
             thread_ts: Thread timestamp. Defaults to the thread_ts from the event context.
             **kwargs: Additional arguments passed to ``AsyncWebClient.assistant_threads_setStatus()``.
 
         Returns:
             ``AsyncSlackResponse`` from the API call.
         """
         return await self._client.assistant_threads_setStatus(
-            channel_id=channel or self._channel_id,  # type: ignore[arg-type]
+            channel_id=channel_id or self._channel_id,  # type: ignore[arg-type]
             thread_ts=thread_ts or self._thread_ts or self._ts,  # type: ignore[arg-type]
             status=status,
             loading_messages=loading_messages,
@@ -105,7 +105,7 @@ async def set_suggested_prompts(
         *,
         prompts: Sequence[Union[str, Dict[str, str]]],
         title: Optional[str] = None,
-        channel: Optional[str] = None,
+        channel_id: Optional[str] = None,
         thread_ts: Optional[str] = None,
         **kwargs,
     ) -> AsyncSlackResponse:
@@ -115,7 +115,7 @@ async def set_suggested_prompts(
             prompts: A sequence of prompts. Each prompt can be either a string
                 (used as both title and message) or a dict with 'title' and 'message' keys.
             title: Optional title for the suggested prompts section.
-            channel: Channel ID. Defaults to the channel from the event context.
+            channel_id: Channel ID. Defaults to the channel from the event context.
             thread_ts: Thread timestamp. Defaults to the thread_ts from the event context.
             **kwargs: Additional arguments passed to ``AsyncWebClient.assistant_threads_setSuggestedPrompts()``.
 
@@ -130,7 +130,7 @@ async def set_suggested_prompts(
                 prompts_arg.append(prompt)
 
         return await self._client.assistant_threads_setSuggestedPrompts(
-            channel_id=channel or self._channel_id,  # type: ignore[arg-type]
+            channel_id=channel_id or self._channel_id,  # type: ignore[arg-type]
             thread_ts=thread_ts or self._thread_ts or self._ts,  # type: ignore[arg-type]
             prompts=prompts_arg,
             title=title,
diff --git a/tests/slack_bolt/agent/test_agent.py b/tests/slack_bolt/agent/test_agent.py
@@ -183,7 +183,7 @@ def test_set_status_with_loading_messages(self):
         )
 
     def test_set_status_overrides_context_defaults(self):
-        """Explicit channel/thread_ts override context defaults."""
+        """Explicit channel_id/thread_ts override context defaults."""
         client = MagicMock(spec=WebClient)
         client.assistant_threads_setStatus.return_value = MagicMock()
 
@@ -196,7 +196,7 @@ def test_set_status_overrides_context_defaults(self):
         )
         agent.set_status(
             status="Thinking...",
-            channel="C999",
+            channel_id="C999",
             thread_ts="9999999999.999999",
         )
 
@@ -295,7 +295,7 @@ def test_set_suggested_prompts_with_dict_prompts(self):
         )
 
     def test_set_suggested_prompts_overrides_context_defaults(self):
-        """Explicit channel/thread_ts override context defaults."""
+        """Explicit channel_id/thread_ts override context defaults."""
         client = MagicMock(spec=WebClient)
         client.assistant_threads_setSuggestedPrompts.return_value = MagicMock()
 
@@ -308,7 +308,7 @@ def test_set_suggested_prompts_overrides_context_defaults(self):
         )
         agent.set_suggested_prompts(
             prompts=["Hello"],
-            channel="C999",
+            channel_id="C999",
             thread_ts="9999999999.999999",
         )
 
diff --git a/tests/slack_bolt_async/agent/test_async_agent.py b/tests/slack_bolt_async/agent/test_async_agent.py
@@ -214,7 +214,7 @@ async def test_set_status_with_loading_messages(self):
 
     @pytest.mark.asyncio
     async def test_set_status_overrides_context_defaults(self):
-        """Explicit channel/thread_ts override context defaults."""
+        """Explicit channel_id/thread_ts override context defaults."""
         client = MagicMock(spec=AsyncWebClient)
         client.assistant_threads_setStatus, call_tracker, _ = _make_async_api_mock()
 
@@ -227,7 +227,7 @@ async def test_set_status_overrides_context_defaults(self):
         )
         await agent.set_status(
             status="Thinking...",
-            channel="C999",
+            channel_id="C999",
             thread_ts="9999999999.999999",
         )
 
@@ -331,7 +331,7 @@ async def test_set_suggested_prompts_with_dict_prompts(self):
 
     @pytest.mark.asyncio
     async def test_set_suggested_prompts_overrides_context_defaults(self):
-        """Explicit channel/thread_ts override context defaults."""
+        """Explicit channel_id/thread_ts override context defaults."""
         client = MagicMock(spec=AsyncWebClient)
         client.assistant_threads_setSuggestedPrompts, call_tracker, _ = _make_async_api_mock()
 
@@ -344,7 +344,7 @@ async def test_set_suggested_prompts_overrides_context_defaults(self):
         )
         await agent.set_suggested_prompts(
             prompts=["Hello"],
-            channel="C999",
+            channel_id="C999",
             thread_ts="9999999999.999999",
         )
 

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ def test_set_status_with_loading_messages(self):`
`183`	`183`	`)`
`184`	`184`
`185`	`185`	`def test_set_status_overrides_context_defaults(self):`
`186`		`- """Explicit channel/thread_ts override context defaults."""`
	`186`	`+ """Explicit channel_id/thread_ts override context defaults."""`
`187`	`187`	`client = MagicMock(spec=WebClient)`
`188`	`188`	`client.assistant_threads_setStatus.return_value = MagicMock()`
`189`	`189`
`@@ -196,7 +196,7 @@ def test_set_status_overrides_context_defaults(self):`
`196`	`196`	`)`
`197`	`197`	`agent.set_status(`
`198`	`198`	`status="Thinking...",`
`199`		`- channel="C999",`
	`199`	`+ channel_id="C999",`
`200`	`200`	`thread_ts="9999999999.999999",`
`201`	`201`	`)`
`202`	`202`
`@@ -295,7 +295,7 @@ def test_set_suggested_prompts_with_dict_prompts(self):`
`295`	`295`	`)`
`296`	`296`
`297`	`297`	`def test_set_suggested_prompts_overrides_context_defaults(self):`
`298`		`- """Explicit channel/thread_ts override context defaults."""`
	`298`	`+ """Explicit channel_id/thread_ts override context defaults."""`
`299`	`299`	`client = MagicMock(spec=WebClient)`
`300`	`300`	`client.assistant_threads_setSuggestedPrompts.return_value = MagicMock()`
`301`	`301`
`@@ -308,7 +308,7 @@ def test_set_suggested_prompts_overrides_context_defaults(self):`
`308`	`308`	`)`
`309`	`309`	`agent.set_suggested_prompts(`
`310`	`310`	`prompts=["Hello"],`
`311`		`- channel="C999",`
	`311`	`+ channel_id="C999",`
`312`	`312`	`thread_ts="9999999999.999999",`
`313`	`313`	`)`
`314`	`314`