Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incomplete types for ChatUnfurlArguments #1530

Closed
1 of 7 tasks
modestfake opened this issue Sep 2, 2022 · 3 comments · Fixed by #1551
Closed
1 of 7 tasks

Incomplete types for ChatUnfurlArguments #1530

modestfake opened this issue Sep 2, 2022 · 3 comments · Fixed by #1551
Assignees
@filmaj
Labels
enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api`
Milestone
[email protected]

Comments

@modestfake
Copy link

According to documentation chat.unfurl accepts either unfurl_id and source or channel and ts. But ChatUnfurlArguments type misses unfurl_id and source params (source).

Packages:

Select all that apply:

  • @slack/web-api
  • @slack/rtm-api
  • @slack/webhooks
  • @slack/oauth
  • @slack/socket-mode
  • @slack/types
  • I don't know
@seratch seratch added enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` and removed untriaged labels Sep 5, 2022
@seratch seratch added this to the [email protected] milestone Sep 5, 2022
@seratch
Copy link
Member

seratch commented Sep 5, 2022

Hi @modestfake, thanks a lot for taking the time to report this issue! You are right that those newly added parameters are not yet supported in this SDK. We will add them here in the next release.

@filmaj filmaj self-assigned this Oct 28, 2022
filmaj added a commit that referenced this issue Oct 28, 2022
@filmaj
ChatUnfurlArguments require either channel and ts or unfurl_id …
8a25b38 
…and `source` properties to be specified in pairs. Fixes #1530.
@filmaj filmaj mentioned this issue Oct 28, 2022
Merged
filmaj added a commit that referenced this issue Oct 28, 2022
@filmaj
ChatUnfurlArguments require either channel and ts or unfurl_id …
245dff4 
…and `source` properties to be specified in pairs. Fixes #1530.
@filmaj
Copy link
Contributor

filmaj commented Oct 28, 2022

There's a discussion in the relevant PR for this issue, #1551, about how to model the mutually-exclusive nature of the pairs of properties channel and ts vs. source and unfurl_id. If folks have opinions on that, like if it's worth it, and different ways of implementing it, please chime in!

filmaj added a commit that referenced this issue Oct 31, 2022
@filmaj
ChatUnfurlArguments require either channel and ts or unfurl_id …
431a7f0 
…and `source` properties to be specified in pairs. Fixes #1530.
filmaj added a commit that referenced this issue Nov 8, 2022
@filmaj
ChatUnfurlArguments require either channel and ts or unfurl_id …
c635b77 
…and `source` properties to be specified in pairs (#1551)

* ChatUnfurlArguments require either `channel` and `ts` or `unfurl_id` and `source` properties to be specified in pairs. Fixes #1530.

* Expand ChatUnfurlArguments to accept either source and unfurl_id, or channel and ts. Add JSDoc for all ChatUnfurlArgument properties.
@filmaj
Copy link
Contributor

filmaj commented Nov 8, 2022

This is now fixed in @slack/web-api v6.8.0 which was just released to npm, btw.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@filmaj filmaj

Labels
enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api`
Projects
None yet
Milestone
[email protected]
3 participants
@seratch @filmaj @modestfake