chore: release rc

appwrite · Aug 17, 2024 · df4648f · df4648f
1 parent 6a1c209
commit df4648f
Show file tree

Hide file tree

Showing 94 changed files with 378 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Appwrite Web SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-web.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.5.7-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.6.0-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
@@ -33,7 +33,7 @@ import { Client, Account } from "appwrite";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/[email protected].1"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected].2"></script>
 ```
 
 

diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.createAnonymousSession();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-email-password-session.md b/docs/examples/account/create-email-password-session.md
@@ -11,4 +11,4 @@ const result = await account.createEmailPasswordSession(
     'password' // password
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md
@@ -12,4 +12,4 @@ const result = await account.createEmailToken(
     false // phrase (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-j-w-t.md b/docs/examples/account/create-j-w-t.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.createJWT();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-magic-u-r-l-token.md b/docs/examples/account/create-magic-u-r-l-token.md
@@ -13,4 +13,4 @@ const result = await account.createMagicURLToken(
     false // phrase (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md
@@ -10,4 +10,4 @@ const result = await account.createMfaAuthenticator(
     AuthenticatorType.Totp // type
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md
@@ -10,4 +10,4 @@ const result = await account.createMfaChallenge(
     AuthenticationFactor.Email // factor
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.createMfaRecoveryCodes();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md
@@ -11,4 +11,4 @@ const result = await account.createPhoneToken(
     '+12065550100' // phone
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-phone-verification.md b/docs/examples/account/create-phone-verification.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.createPhoneVerification();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-push-target.md b/docs/examples/account/create-push-target.md
@@ -12,4 +12,4 @@ const result = await account.createPushTarget(
     '<PROVIDER_ID>' // providerId (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md
@@ -11,4 +11,4 @@ const result = await account.createRecovery(
     'https://example.com' // url
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md
@@ -11,4 +11,4 @@ const result = await account.createSession(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md
@@ -10,4 +10,4 @@ const result = await account.createVerification(
     'https://example.com' // url
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md
@@ -13,4 +13,4 @@ const result = await account.create(
     '<NAME>' // name (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md
@@ -10,4 +10,4 @@ const result = await account.deleteIdentity(
     '<IDENTITY_ID>' // identityId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md
@@ -7,8 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deleteMfaAuthenticator(
-    AuthenticatorType.Totp, // type
-    '<OTP>' // otp
+    AuthenticatorType.Totp // type
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/delete-push-target.md b/docs/examples/account/delete-push-target.md
@@ -10,4 +10,4 @@ const result = await account.deletePushTarget(
     '<TARGET_ID>' // targetId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md
@@ -10,4 +10,4 @@ const result = await account.deleteSession(
     '<SESSION_ID>' // sessionId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.deleteSessions();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.getMfaRecoveryCodes();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.getPrefs();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md
@@ -10,4 +10,4 @@ const result = await account.getSession(
     '<SESSION_ID>' // sessionId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.get();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md
@@ -10,4 +10,4 @@ const result = await account.listIdentities(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md
@@ -10,4 +10,4 @@ const result = await account.listLogs(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.listMfaFactors();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/list-sessions.md b/docs/examples/account/list-sessions.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.listSessions();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md
@@ -11,4 +11,4 @@ const result = await account.updateEmail(
     'password' // password
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-m-f-a.md b/docs/examples/account/update-m-f-a.md
@@ -10,4 +10,4 @@ const result = await account.updateMFA(
     false // mfa
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-magic-u-r-l-session.md b/docs/examples/account/update-magic-u-r-l-session.md
@@ -11,4 +11,4 @@ const result = await account.updateMagicURLSession(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md
@@ -11,4 +11,4 @@ const result = await account.updateMfaAuthenticator(
     '<OTP>' // otp
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md
@@ -11,4 +11,4 @@ const result = await account.updateMfaChallenge(
     '<OTP>' // otp
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.updateMfaRecoveryCodes();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md
@@ -10,4 +10,4 @@ const result = await account.updateName(
     '<NAME>' // name
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md
@@ -11,4 +11,4 @@ const result = await account.updatePassword(
     'password' // oldPassword (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-phone-session.md b/docs/examples/account/update-phone-session.md
@@ -11,4 +11,4 @@ const result = await account.updatePhoneSession(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md
@@ -11,4 +11,4 @@ const result = await account.updatePhoneVerification(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-phone.md b/docs/examples/account/update-phone.md
@@ -11,4 +11,4 @@ const result = await account.updatePhone(
     'password' // password
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md
@@ -10,4 +10,4 @@ const result = await account.updatePrefs(
     {} // prefs
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-push-target.md b/docs/examples/account/update-push-target.md
@@ -11,4 +11,4 @@ const result = await account.updatePushTarget(
     '<IDENTIFIER>' // identifier
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md
@@ -12,4 +12,4 @@ const result = await account.updateRecovery(
     '' // password
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md
@@ -10,4 +10,4 @@ const result = await account.updateSession(
     '<SESSION_ID>' // sessionId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-status.md b/docs/examples/account/update-status.md
@@ -8,4 +8,4 @@ const account = new Account(client);
 
 const result = await account.updateStatus();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md
@@ -11,4 +11,4 @@ const result = await account.updateVerification(
     '<SECRET>' // secret
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -14,4 +14,4 @@ const result = await databases.createDocument(
     ["read("any")"] // permissions (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md
@@ -12,4 +12,4 @@ const result = await databases.deleteDocument(
     '<DOCUMENT_ID>' // documentId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md
@@ -13,4 +13,4 @@ const result = await databases.getDocument(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md
@@ -12,4 +12,4 @@ const result = await databases.listDocuments(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md
@@ -14,4 +14,4 @@ const result = await databases.updateDocument(
     ["read("any")"] // permissions (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md
@@ -16,4 +16,4 @@ const result = await functions.createExecution(
     '' // scheduledAt (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md
@@ -0,0 +1,14 @@
+import { Client, Functions } from "appwrite";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('&lt;YOUR_PROJECT_ID&gt;'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = functions.getDeploymentDownload(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
+
+console.log(result);
diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md
@@ -11,4 +11,4 @@ const result = await functions.getExecution(
     '<EXECUTION_ID>' // executionId
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/functions/get-template.md b/docs/examples/functions/get-template.md
@@ -0,0 +1,13 @@
+import { Client, Functions } from "appwrite";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('&lt;YOUR_PROJECT_ID&gt;'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.getTemplate(
+    '<TEMPLATE_ID>' // templateId
+);
+
+console.log(result);
diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md
@@ -12,4 +12,4 @@ const result = await functions.listExecutions(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/functions/list-templates.md b/docs/examples/functions/list-templates.md
@@ -0,0 +1,16 @@
+import { Client, Functions } from "appwrite";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('&lt;YOUR_PROJECT_ID&gt;'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.listTemplates(
+    [], // runtimes (optional)
+    [], // useCases (optional)
+    1, // limit (optional)
+    0 // offset (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/graphql/mutation.md b/docs/examples/graphql/mutation.md
@@ -10,4 +10,4 @@ const result = await graphql.mutation(
     {} // query
 );
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/graphql/query.md b/docs/examples/graphql/query.md
@@ -10,4 +10,4 @@ const result = await graphql.query(
     {} // query
 );
 
-console.log(response);
+console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.createAnonymousSession();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.createJWT();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.createMfaRecoveryCodes();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.createPhoneVerification();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.deleteSessions();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.getMfaRecoveryCodes();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.getPrefs();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.get();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.listMfaFactors();

		console.log(response);
		console.log(result);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,4 @@ const account = new Account(client);

		const result = await account.listSessions();

		console.log(response);
		console.log(result);