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.

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

fix: Update node subscriber feed params typings #3376

Merged
merged 1 commit into from
May 10, 2023

Conversation

shanehandley-lived
Copy link
Contributor

What change does this PR introduce?

According to the OpenAPI documentation and testing, the feedIdentifier param is optional when fetching a subscriber's notification feed.

The node client typings have this parameter as required. This updates the node client typings to reflect the API definition, so that the param can be excluded.

Why was this change needed?

The feedIdentifier is an optional parameter, and the API accepts an empty object as the second argument to getNotificationsFeed, but it requires suppressing the following typescript error:

Argument of type '{}' is not assignable to parameter of type 'IGetSubscriberNotificationFeedParams'.
  Property 'feedIdentifier' is missing in type '{}' but required in type 'IGetSubscriberNotificationFeedParams'.ts(2345)
subscriber.interface.d.ts(27, 5): 'feedIdentifier' is declared here.

@shanehandley-lived shanehandley-lived changed the title Update node subscriber feed params typings fix: Update node subscriber feed params typings May 10, 2023
Copy link
Contributor

@p-fernandez p-fernandez left a comment

Choose a reason for hiding this comment

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

🌟
Great addition with the tests.

@p-fernandez p-fernandez added this pull request to the merge queue May 10, 2023
Merged via the queue into novuhq:next with commit 1811193 May 10, 2023
@shanehandley-lived shanehandley-lived deleted the client-feed-typings branch May 10, 2023 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants