Skip to content

Commit 8b440f9

Browse files
zimegClaude
andcommitted
fix(web-api): correct codeChannels.* method arguments
Align the codeChannels.* signatures with the API reference: - create: add team_id, is_private; make origin_channel_id/origin_message_ts optional (name-only creation is valid; the origin pair is optional) - setView: make type optional (defaults to html); add view_key, blocks, canvas_id, access_level, name, label, csp - removeView: make view_id optional; add view_key (provide exactly one) - getCanvas: add required canvas_id; add content_format, include_resolved - setCanvasContent: add required canvas_id - setProperties: add agent_resource Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
1 parent c84fb38 commit 8b440f9

4 files changed

Lines changed: 147 additions & 40 deletions

File tree

‎slack_sdk/web/async_client.py‎

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2117,9 +2117,11 @@ async def codeChannels_create(
21172117
self,
21182118
*,
21192119
name: str,
2120-
origin_channel_id: str,
2121-
origin_message_ts: str,
2120+
team_id: Optional[str] = None,
21222121
session_id: Optional[str] = None,
2122+
is_private: Optional[bool] = None,
2123+
origin_channel_id: Optional[str] = None,
2124+
origin_message_ts: Optional[str] = None,
21232125
**kwargs,
21242126
) -> AsyncSlackResponse:
21252127
"""Create a code channel for a session.
@@ -2128,9 +2130,11 @@ async def codeChannels_create(
21282130
kwargs.update(
21292131
{
21302132
"name": name,
2133+
"team_id": team_id,
2134+
"session_id": session_id,
2135+
"is_private": is_private,
21312136
"origin_channel_id": origin_channel_id,
21322137
"origin_message_ts": origin_message_ts,
2133-
"session_id": session_id,
21342138
}
21352139
)
21362140
kwargs = _remove_none_values(kwargs)
@@ -2169,12 +2173,19 @@ async def codeChannels_setProperties(
21692173
*,
21702174
channel_id: str,
21712175
code_channel: Optional[Dict[str, Any]] = None,
2176+
agent_resource: Optional[Dict[str, Any]] = None,
21722177
**kwargs,
21732178
) -> AsyncSlackResponse:
21742179
"""Set a code channel's context bar items and external resource details.
21752180
https://docs.slack.dev/reference/methods/codeChannels.setProperties
21762181
"""
2177-
kwargs.update({"channel_id": channel_id, "code_channel": code_channel})
2182+
kwargs.update(
2183+
{
2184+
"channel_id": channel_id,
2185+
"code_channel": code_channel,
2186+
"agent_resource": agent_resource,
2187+
}
2188+
)
21782189
kwargs = _remove_none_values(kwargs)
21792190
return await self.api_call("codeChannels.setProperties", json=kwargs)
21802191

@@ -2196,10 +2207,17 @@ async def codeChannels_setView(
21962207
self,
21972208
*,
21982209
channel_id: str,
2199-
type: str,
2210+
type: Optional[str] = None,
2211+
view_key: Optional[str] = None,
22002212
content: Optional[str] = None,
2213+
blocks: Optional[List[Dict[str, Any]]] = None,
2214+
canvas_id: Optional[str] = None,
2215+
access_level: Optional[str] = None,
22012216
base_branch: Optional[str] = None,
22022217
head_branch: Optional[str] = None,
2218+
name: Optional[str] = None,
2219+
label: Optional[str] = None,
2220+
csp: Optional[Dict[str, Any]] = None,
22032221
**kwargs,
22042222
) -> AsyncSlackResponse:
22052223
"""Create or update a view tab (html, diff, block_kit, or canvas) on a code channel.
@@ -2209,9 +2227,16 @@ async def codeChannels_setView(
22092227
{
22102228
"channel_id": channel_id,
22112229
"type": type,
2230+
"view_key": view_key,
22122231
"content": content,
2232+
"blocks": blocks,
2233+
"canvas_id": canvas_id,
2234+
"access_level": access_level,
22132235
"base_branch": base_branch,
22142236
"head_branch": head_branch,
2237+
"name": name,
2238+
"label": label,
2239+
"csp": csp,
22152240
}
22162241
)
22172242
kwargs = _remove_none_values(kwargs)
@@ -2234,40 +2259,52 @@ async def codeChannels_removeView(
22342259
self,
22352260
*,
22362261
channel_id: str,
2237-
view_id: str,
2262+
view_key: Optional[str] = None,
2263+
view_id: Optional[str] = None,
22382264
**kwargs,
22392265
) -> AsyncSlackResponse:
2240-
"""Remove a view tab from a code channel.
2266+
"""Remove a view tab from a code channel (provide exactly one of view_key or view_id).
22412267
https://docs.slack.dev/reference/methods/codeChannels.removeView
22422268
"""
2243-
kwargs.update({"channel_id": channel_id, "view_id": view_id})
2269+
kwargs.update({"channel_id": channel_id, "view_key": view_key, "view_id": view_id})
22442270
kwargs = _remove_none_values(kwargs)
22452271
return await self.api_call("codeChannels.removeView", json=kwargs)
22462272

22472273
async def codeChannels_getCanvas(
22482274
self,
22492275
*,
22502276
channel_id: str,
2277+
canvas_id: str,
2278+
content_format: Optional[str] = None,
2279+
include_resolved: Optional[bool] = None,
22512280
**kwargs,
22522281
) -> AsyncSlackResponse:
22532282
"""Read a code channel canvas's content and its comment threads.
22542283
https://docs.slack.dev/reference/methods/codeChannels.getCanvas
22552284
"""
2256-
kwargs.update({"channel_id": channel_id})
2285+
kwargs.update(
2286+
{
2287+
"channel_id": channel_id,
2288+
"canvas_id": canvas_id,
2289+
"content_format": content_format,
2290+
"include_resolved": include_resolved,
2291+
}
2292+
)
22572293
kwargs = _remove_none_values(kwargs)
22582294
return await self.api_call("codeChannels.getCanvas", json=kwargs)
22592295

22602296
async def codeChannels_setCanvasContent(
22612297
self,
22622298
*,
22632299
channel_id: str,
2300+
canvas_id: str,
22642301
content: str,
22652302
**kwargs,
22662303
) -> AsyncSlackResponse:
22672304
"""Replace a code channel canvas's content while preserving comment anchors.
22682305
https://docs.slack.dev/reference/methods/codeChannels.setCanvasContent
22692306
"""
2270-
kwargs.update({"channel_id": channel_id, "content": content})
2307+
kwargs.update({"channel_id": channel_id, "canvas_id": canvas_id, "content": content})
22712308
kwargs = _remove_none_values(kwargs)
22722309
return await self.api_call("codeChannels.setCanvasContent", json=kwargs)
22732310

‎slack_sdk/web/client.py‎

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2107,9 +2107,11 @@ def codeChannels_create(
21072107
self,
21082108
*,
21092109
name: str,
2110-
origin_channel_id: str,
2111-
origin_message_ts: str,
2110+
team_id: Optional[str] = None,
21122111
session_id: Optional[str] = None,
2112+
is_private: Optional[bool] = None,
2113+
origin_channel_id: Optional[str] = None,
2114+
origin_message_ts: Optional[str] = None,
21132115
**kwargs,
21142116
) -> SlackResponse:
21152117
"""Create a code channel for a session.
@@ -2118,9 +2120,11 @@ def codeChannels_create(
21182120
kwargs.update(
21192121
{
21202122
"name": name,
2123+
"team_id": team_id,
2124+
"session_id": session_id,
2125+
"is_private": is_private,
21212126
"origin_channel_id": origin_channel_id,
21222127
"origin_message_ts": origin_message_ts,
2123-
"session_id": session_id,
21242128
}
21252129
)
21262130
kwargs = _remove_none_values(kwargs)
@@ -2159,12 +2163,19 @@ def codeChannels_setProperties(
21592163
*,
21602164
channel_id: str,
21612165
code_channel: Optional[Dict[str, Any]] = None,
2166+
agent_resource: Optional[Dict[str, Any]] = None,
21622167
**kwargs,
21632168
) -> SlackResponse:
21642169
"""Set a code channel's context bar items and external resource details.
21652170
https://docs.slack.dev/reference/methods/codeChannels.setProperties
21662171
"""
2167-
kwargs.update({"channel_id": channel_id, "code_channel": code_channel})
2172+
kwargs.update(
2173+
{
2174+
"channel_id": channel_id,
2175+
"code_channel": code_channel,
2176+
"agent_resource": agent_resource,
2177+
}
2178+
)
21682179
kwargs = _remove_none_values(kwargs)
21692180
return self.api_call("codeChannels.setProperties", json=kwargs)
21702181

@@ -2186,10 +2197,17 @@ def codeChannels_setView(
21862197
self,
21872198
*,
21882199
channel_id: str,
2189-
type: str,
2200+
type: Optional[str] = None,
2201+
view_key: Optional[str] = None,
21902202
content: Optional[str] = None,
2203+
blocks: Optional[List[Dict[str, Any]]] = None,
2204+
canvas_id: Optional[str] = None,
2205+
access_level: Optional[str] = None,
21912206
base_branch: Optional[str] = None,
21922207
head_branch: Optional[str] = None,
2208+
name: Optional[str] = None,
2209+
label: Optional[str] = None,
2210+
csp: Optional[Dict[str, Any]] = None,
21932211
**kwargs,
21942212
) -> SlackResponse:
21952213
"""Create or update a view tab (html, diff, block_kit, or canvas) on a code channel.
@@ -2199,9 +2217,16 @@ def codeChannels_setView(
21992217
{
22002218
"channel_id": channel_id,
22012219
"type": type,
2220+
"view_key": view_key,
22022221
"content": content,
2222+
"blocks": blocks,
2223+
"canvas_id": canvas_id,
2224+
"access_level": access_level,
22032225
"base_branch": base_branch,
22042226
"head_branch": head_branch,
2227+
"name": name,
2228+
"label": label,
2229+
"csp": csp,
22052230
}
22062231
)
22072232
kwargs = _remove_none_values(kwargs)
@@ -2224,40 +2249,52 @@ def codeChannels_removeView(
22242249
self,
22252250
*,
22262251
channel_id: str,
2227-
view_id: str,
2252+
view_key: Optional[str] = None,
2253+
view_id: Optional[str] = None,
22282254
**kwargs,
22292255
) -> SlackResponse:
2230-
"""Remove a view tab from a code channel.
2256+
"""Remove a view tab from a code channel (provide exactly one of view_key or view_id).
22312257
https://docs.slack.dev/reference/methods/codeChannels.removeView
22322258
"""
2233-
kwargs.update({"channel_id": channel_id, "view_id": view_id})
2259+
kwargs.update({"channel_id": channel_id, "view_key": view_key, "view_id": view_id})
22342260
kwargs = _remove_none_values(kwargs)
22352261
return self.api_call("codeChannels.removeView", json=kwargs)
22362262

22372263
def codeChannels_getCanvas(
22382264
self,
22392265
*,
22402266
channel_id: str,
2267+
canvas_id: str,
2268+
content_format: Optional[str] = None,
2269+
include_resolved: Optional[bool] = None,
22412270
**kwargs,
22422271
) -> SlackResponse:
22432272
"""Read a code channel canvas's content and its comment threads.
22442273
https://docs.slack.dev/reference/methods/codeChannels.getCanvas
22452274
"""
2246-
kwargs.update({"channel_id": channel_id})
2275+
kwargs.update(
2276+
{
2277+
"channel_id": channel_id,
2278+
"canvas_id": canvas_id,
2279+
"content_format": content_format,
2280+
"include_resolved": include_resolved,
2281+
}
2282+
)
22472283
kwargs = _remove_none_values(kwargs)
22482284
return self.api_call("codeChannels.getCanvas", json=kwargs)
22492285

22502286
def codeChannels_setCanvasContent(
22512287
self,
22522288
*,
22532289
channel_id: str,
2290+
canvas_id: str,
22542291
content: str,
22552292
**kwargs,
22562293
) -> SlackResponse:
22572294
"""Replace a code channel canvas's content while preserving comment anchors.
22582295
https://docs.slack.dev/reference/methods/codeChannels.setCanvasContent
22592296
"""
2260-
kwargs.update({"channel_id": channel_id, "content": content})
2297+
kwargs.update({"channel_id": channel_id, "canvas_id": canvas_id, "content": content})
22612298
kwargs = _remove_none_values(kwargs)
22622299
return self.api_call("codeChannels.setCanvasContent", json=kwargs)
22632300

0 commit comments

Comments
 (0)