node-appwrite 12.0.0-rc.4 → 12.0.0

package/docs/examples/users/delete-session.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.deleteSession(
-    '[USER_ID]', // userId
-    '[SESSION_ID]' // sessionId
+const result = await users.deleteSession(
+    '<USER_ID>', // userId
+    '<SESSION_ID>' // sessionId
 );

package/docs/examples/users/delete-sessions.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.deleteSessions(
-    '[USER_ID]' // userId
+const result = await users.deleteSessions(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/delete-target.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.deleteTarget(
-    '[USER_ID]', // userId
-    '[TARGET_ID]' // targetId
+const result = await users.deleteTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>' // targetId
 );

package/docs/examples/users/delete.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.delete(
-    '[USER_ID]' // userId
+const result = await users.delete(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/get-mfa-recovery-codes.md

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const users = new sdk.Users(client);
+
+const result = await users.getMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);

package/docs/examples/users/get-prefs.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.getPrefs(
-    '[USER_ID]' // userId
+const result = await users.getPrefs(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/get-target.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.getTarget(
-    '[USER_ID]', // userId
-    '[TARGET_ID]' // targetId
+const result = await users.getTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>' // targetId
 );

package/docs/examples/users/get.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.get(
-    '[USER_ID]' // userId
+const result = await users.get(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/list-identities.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listIdentities(
+const result = await users.listIdentities(
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

package/docs/examples/users/list-logs.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listLogs(
-    '[USER_ID]', // userId
+const result = await users.listLogs(
+    '<USER_ID>', // userId
     [] // queries (optional)
 );

package/docs/examples/users/list-memberships.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listMemberships(
-    '[USER_ID]' // userId
+const result = await users.listMemberships(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/{list-factors.md → list-mfa-factors.md}

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listFactors(
-    '[USER_ID]' // userId
+const result = await users.listMfaFactors(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/list-sessions.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listSessions(
-    '[USER_ID]' // userId
+const result = await users.listSessions(
+    '<USER_ID>' // userId
 );

package/docs/examples/users/list-targets.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.listTargets(
-    '[USER_ID]', // userId
+const result = await users.listTargets(
+    '<USER_ID>', // userId
     [] // queries (optional)
 );

package/docs/examples/users/list.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.list(
+const result = await users.list(
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

package/docs/examples/users/update-email-verification.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateEmailVerification(
-    '[USER_ID]', // userId
+const result = await users.updateEmailVerification(
+    '<USER_ID>', // userId
     false // emailVerification
 );

package/docs/examples/users/update-email.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateEmail(
-    '[USER_ID]', // userId
+const result = await users.updateEmail(
+    '<USER_ID>', // userId
     'email@example.com' // email
 );

package/docs/examples/users/update-labels.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateLabels(
-    '[USER_ID]', // userId
+const result = await users.updateLabels(
+    '<USER_ID>', // userId
     [] // labels
 );

package/docs/examples/users/update-mfa-recovery-codes.md

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const users = new sdk.Users(client);
+
+const result = await users.updateMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);

package/docs/examples/users/update-mfa.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateMfa(
-    '[USER_ID]', // userId
+const result = await users.updateMfa(
+    '<USER_ID>', // userId
     false // mfa
 );

package/docs/examples/users/update-name.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateName(
-    '[USER_ID]', // userId
-    '[NAME]' // name
+const result = await users.updateName(
+    '<USER_ID>', // userId
+    '<NAME>' // name
 );

package/docs/examples/users/update-password.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updatePassword(
-    '[USER_ID]', // userId
+const result = await users.updatePassword(
+    '<USER_ID>', // userId
     '' // password
 );

package/docs/examples/users/update-phone-verification.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updatePhoneVerification(
-    '[USER_ID]', // userId
+const result = await users.updatePhoneVerification(
+    '<USER_ID>', // userId
     false // phoneVerification
 );

package/docs/examples/users/update-phone.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updatePhone(
-    '[USER_ID]', // userId
+const result = await users.updatePhone(
+    '<USER_ID>', // userId
     '+12065550100' // number
 );

package/docs/examples/users/update-prefs.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updatePrefs(
-    '[USER_ID]', // userId
+const result = await users.updatePrefs(
+    '<USER_ID>', // userId
     {} // prefs
 );

package/docs/examples/users/update-status.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateStatus(
-    '[USER_ID]', // userId
+const result = await users.updateStatus(
+    '<USER_ID>', // userId
     false // status
 );

package/docs/examples/users/update-target.md

@@ -7,10 +7,10 @@ const client = new sdk.Client()
 
 const users = new sdk.Users(client);
 
-const response = await users.updateTarget(
-    '[USER_ID]', // userId
-    '[TARGET_ID]', // targetId
-    '[IDENTIFIER]', // identifier (optional)
-    '[PROVIDER_ID]', // providerId (optional)
-    '[NAME]' // name (optional)
+const result = await users.updateTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>', // targetId
+    '<IDENTIFIER>', // identifier (optional)
+    '<PROVIDER_ID>', // providerId (optional)
+    '<NAME>' // name (optional)
 );