fix(backend): Add filter by status support for getInvitationList method

fix(backend): Add filter by status support for getInvitationList method fix(backend): Add JSdoc
clerk · Jul 28, 2023 · 876777c · 876777c
1 parent 0b9388c
commit 876777c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.changeset/sixty-eyes-attend.md b/.changeset/sixty-eyes-attend.md
@@ -0,0 +1,5 @@
+---
+'@clerk/backend': minor
+---
+
+Add filter by status(pending, accepted, revoked) support for getInvitationList method
diff --git a/packages/backend/src/api/endpoints/InvitationApi.ts b/packages/backend/src/api/endpoints/InvitationApi.ts
@@ -10,11 +10,26 @@ type CreateParams = {
   publicMetadata?: UserPublicMetadata;
 };
 
+type GetInvitationListParams = {
+  /**
+   * Filters invitations based on their status(accepted, pending, revoked).
+   *
+   * @example
+   * get all revoked invitations
+   *
+   * import { invitations } from '@clerk/clerk-sdk-node';
+   * await invitations.getInvitationList({ status: 'revoked })
+   *
+   */
+  status?: 'accepted' | 'pending' | 'revoked';
+};
+
 export class InvitationAPI extends AbstractAPI {
-  public async getInvitationList() {
+  public async getInvitationList(params: GetInvitationListParams = {}) {
     return this.request<Invitation[]>({
       method: 'GET',
       path: basePath,
+      queryParams: params,
     });
   }