Skip to content

Commit b598581

Browse files
authored
fix(backend): Inconsistent create params for Invite & Org Invite (#6750)
1 parent 773d71c commit b598581

File tree

3 files changed

+20
-7
lines changed

3 files changed

+20
-7
lines changed

.changeset/all-hats-float.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/backend': patch
3+
---
4+
5+
Align create params for Invitation and OrganizationInvitation with backend API

packages/backend/src/api/endpoints/InvitationApi.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ import { AbstractAPI } from './AbstractApi';
88

99
const basePath = '/invitations';
1010

11+
type TemplateSlug = 'invitation' | 'waitlist_invitation';
12+
1113
type CreateParams = {
1214
emailAddress: string;
13-
redirectUrl?: string;
14-
publicMetadata?: UserPublicMetadata;
15-
notify?: boolean;
15+
expiresInDays?: number;
1616
ignoreExisting?: boolean;
17+
notify?: boolean;
18+
publicMetadata?: UserPublicMetadata;
19+
redirectUrl?: string;
20+
templateSlug: TemplateSlug;
1721
};
1822

1923
type GetInvitationListParams = ClerkPaginationRequest<{

packages/backend/src/api/endpoints/OrganizationApi.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,19 +164,23 @@ type DeleteOrganizationMembershipParams = {
164164

165165
type CreateOrganizationInvitationParams = {
166166
organizationId: string;
167-
inviterUserId?: string;
168167
emailAddress: string;
169168
role: OrganizationMembershipRole;
170-
redirectUrl?: string;
169+
expiresInDays?: number;
170+
inviterUserId?: string;
171+
privateMetadata?: OrganizationInvitationPrivateMetadata;
171172
publicMetadata?: OrganizationInvitationPublicMetadata;
173+
redirectUrl?: string;
172174
};
173175

174176
type CreateBulkOrganizationInvitationParams = Array<{
175-
inviterUserId?: string;
176177
emailAddress: string;
177178
role: OrganizationMembershipRole;
178-
redirectUrl?: string;
179+
expiresInDays?: number;
180+
inviterUserId?: string;
181+
privateMetadata?: OrganizationInvitationPrivateMetadata;
179182
publicMetadata?: OrganizationInvitationPublicMetadata;
183+
redirectUrl?: string;
180184
}>;
181185

182186
type GetOrganizationInvitationListParams = ClerkPaginationRequest<{

0 commit comments

Comments
 (0)