Skip to content

Comments

feat(web-api): add recipient_team_id and recipient_user_id to chat.startStream method#2377

Merged
mwbrooks merged 3 commits intoai-appsfrom
mbrooks-ai-apps-recipient-types
Sep 23, 2025
Merged

feat(web-api): add recipient_team_id and recipient_user_id to chat.startStream method#2377
mwbrooks merged 3 commits intoai-appsfrom
mbrooks-ai-apps-recipient-types

Conversation

@mwbrooks
Copy link
Member

@mwbrooks mwbrooks commented Sep 23, 2025

Summary

This pull request add 2 optional types to the chat.startStream method:

  • recipient_team_id is an optional Team ID that is required when recipient_user_id exists
  • recipient_user_id is an optional User ID that is required when recipient_team_id exists

The developer must provide these optional params when starting a conversation stream outside of a DM.

Reviewers

I didn't add additional logic to enforce the co-dependence between the params. As far as I can tell, the other types let the API return an error instead of adding that logic inside the SDK.

Requirements (place an x in each [ ])

@mwbrooks mwbrooks requested review from srtaalej and zimeg September 23, 2025 04:14
@mwbrooks mwbrooks self-assigned this Sep 23, 2025
@mwbrooks mwbrooks added semver:minor enhancement M-T: A feature request for new functionality area:typescript issues that specifically impact using the package from typescript projects pkg:web-api applies to `@slack/web-api` labels Sep 23, 2025
@codecov
Copy link

codecov bot commented Sep 23, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (ai-apps@0cdae24). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@            Coverage Diff             @@
##             ai-apps    #2377   +/-   ##
==========================================
  Coverage           ?   92.78%           
==========================================
  Files              ?       39           
  Lines              ?    10711           
  Branches           ?      692           
==========================================
  Hits               ?     9938           
  Misses             ?      761           
  Partials           ?       12
Flag Coverage Δ
cli-hooks 95.23% <ø> (?)
cli-test 94.80% <ø> (?)
oauth 77.39% <ø> (?)
socket-mode 61.87% <ø> (?)
web-api 98.00% <ø> (?)
webhook 96.66% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zimeg
zimeg approved these changes Sep 23, 2025
View reviewed changes
Copy link
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mwbrooks Nice! And LGTM!

I think you make a good call with leaving the parameter validation to the API since I imagine various cases are abound 👁️‍🗨️ ✨

@mwbrooks
Copy link
Member Author

mwbrooks commented Sep 23, 2025

Thanks for the quick review @zimeg! 🙇🏻 I'll hit merge on this one and look at repeating it for the Python SDK next. 🐍

@mwbrooks mwbrooks merged commit 942bbda into ai-apps Sep 23, 2025
57 checks passed
@mwbrooks mwbrooks deleted the mbrooks-ai-apps-recipient-types branch September 23, 2025 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zimeg zimeg zimeg approved these changes

@srtaalej srtaalej Awaiting requested review from srtaalej

Assignees

@mwbrooks mwbrooks

Labels

area:typescript issues that specifically impact using the package from typescript projects enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:minor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mwbrooks @zimeg