Add missing properties to UsersInfoResponse

slackapi / node-slack-sdk

Slack Developer Kit for Node.js

https://slack.dev/node-slack-sdk

MIT License

3.27k stars 660 forks source link

Add missing properties to UsersInfoResponse #1490

Closed AdriannaBeck closed 2 years ago

AdriannaBeck commented 2 years ago

Description:

As seen on Slack's documentation page for a User object, a user contains an is_invited_user property. However, this property is currently not present in the User interface in the UsersInfoResponse file.

Packages:

Select all that apply:

[x] @slack/web-api
[ ] @slack/rtm-api
[ ] @slack/webhooks
[ ] @slack/oauth
[ ] @slack/socket-mode
[ ] I don't know

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

mwbrooks commented 2 years ago

Hey @AdriannaBeck 👋🏻 Thanks for the TypeScript suggestion!

I agree, I don't see a reason why we can't type is_invited_user. Sometimes types are difficult with Slack API responses that are fluid, but I don't believe that's the case here.

Feel free to follow-up with a pull request otherwise one of the maintainers will pick up this issue!

neptunel commented 2 years ago

Hello @AdriannaBeck, just wanted to double-check. How are you using the user object type? Do you receive a response including is_invited_user when you make an API call? I wanted to confirm whether this field actually does get sent along with the response payloads, so we can either update the Slack documentation page or the type in the interface.

seratch commented 2 years ago

@AdriannaBeck Thanks for taking the time to report this issue. We've confirmed that the flag can exist under some conditions. My pull request https://github.com/slackapi/node-slack-sdk/pull/1491 will resolve this issue.