Skip to content

fix(backend): Added missing types to create invitation #2268

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

Merged
merged 4 commits into from
Dec 6, 2023

Conversation

royanger
Copy link
Member

@royanger royanger commented Dec 5, 2023

Description

The https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation endpoint accepts delay and ignored_existing params, but the SDK does not (

).

Fixes SDK-1051

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

Copy link

changeset-bot bot commented Dec 5, 2023

🦋 Changeset detected

Latest commit: 1df7e39

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@clerk/backend Patch
@clerk/fastify Patch
gatsby-plugin-clerk Patch
@clerk/nextjs Patch
@clerk/remix Patch
@clerk/clerk-sdk-node Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -8,6 +8,8 @@ type CreateParams = {
emailAddress: string;
redirectUrl?: string;
publicMetadata?: UserPublicMetadata;
delay?: boolean;
Copy link
Member

Choose a reason for hiding this comment

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

I don't see delay mentioned in the BAPI docs and also can't find it (quick glance) in the source code. Where would that be coming from?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see a delay param either but there is a notify?: boolean instead.
ref: https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation!path=notify&t=request

@royanger royanger requested a review from LekoArts December 6, 2023 12:36
Copy link
Member

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Thanks!

@LekoArts LekoArts added this pull request to the merge queue Dec 6, 2023
Merged via the queue into main with commit de6519d Dec 6, 2023
@LekoArts LekoArts deleted the roy/fix-create-invite-for-backend-sdk branch December 6, 2023 12:48
@panteliselef
Copy link
Member

@royanger @LekoArts Was a customer having issues ? Should we backport this to v4 ?

@royanger
Copy link
Member Author

royanger commented Dec 6, 2023

This was a report from a customer @panteliselef. I advised that a fix would be coming but that they could use the BAPI directly until then. If backporting isn't hard (I don't recall the steps involved) then it would be nice for the customer.

panteliselef pushed a commit that referenced this pull request Dec 7, 2023
* fix(backend): Added missing types to create invitation

* Update .changeset/fast-swans-smile.md

Co-authored-by: Lennart <[email protected]>

* fix(backend): Fixed typo

---------

Co-authored-by: Lennart <[email protected]>
(cherry picked from commit de6519d)
github-merge-queue bot pushed a commit that referenced this pull request Dec 7, 2023
* fix(backend): Added missing types to create invitation

* Update .changeset/fast-swans-smile.md

Co-authored-by: Lennart <[email protected]>

* fix(backend): Fixed typo

---------

Co-authored-by: Lennart <[email protected]>
(cherry picked from commit de6519d)

Co-authored-by: Roy Anger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants