docs(api-sdk): add checkInvite docs

bandada-infra · Nov 4, 2024 · a978e98 · a978e98
1 parent 8e9dd3d
commit a978e98
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/libs/api-sdk/README.md b/libs/api-sdk/README.md
@@ -521,6 +521,19 @@ const apiKey = "70f07d0d-6aa2-4fe1-b4b9-06c271a641dc"
 const invite = await apiSdk.getInvite(inviteCode)
 ```
 
+## Check invite
+
+\# **checkInvite**(): _Promise\<boolean>_
+
+Returns boolean value if the invite code is valid.
+
+```ts
+const inviteCode = "C5VAG4HD"
+const groupId = "10402173435763029700781503965100"
+
+const isValid = await apiSdk.checkInvite(inviteCode, groupId)
+```
+
 ## Redeem invite
 
 \# **redeemInvite**(): _Promise\<Invite>_