SDK binary support for executions

appwrite · Sep 18, 2024 · 84a3b90 · 84a3b90
1 parent d8d8e3c
commit 84a3b90
Show file tree

Hide file tree

Showing 115 changed files with 2,542 additions and 1,892 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # 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)
 
-**This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/releases).**
+**This SDK is compatible with Appwrite server version 1.6.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-web/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
@@ -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/appwrite@15.0.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@17.0.0-rc1"></script>
 ```
 
 

diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,12 +2,12 @@ import { Client, Account, AuthenticatorType } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,12 +2,12 @@ import { Client, Account, AuthenticationFactor } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 const result = await account.createMfaRecoveryCodes();
 
-console.log(response);
+console.log(result);
diff --git a/docs/examples/account/create-o-auth2session.md b/docs/examples/account/create-o-auth2session.md
@@ -2,7 +2,7 @@ import { Client, Account, OAuthProvider } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 

diff --git a/docs/examples/account/create-o-auth2token.md b/docs/examples/account/create-o-auth2token.md
@@ -2,7 +2,7 @@ import { Client, Account, OAuthProvider } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 

diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,12 +2,12 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,7 +2,7 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
@@ -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
@@ -2,12 +2,12 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,13 +2,12 @@ import { Client, Account, AuthenticatorType } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,12 +2,12 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,12 +2,12 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 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
@@ -2,12 +2,12 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 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
@@ -2,10 +2,10 @@ import { Client, Account } from "appwrite";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const account = new Account(client);
 
 const result = await account.get();
 
-console.log(response);
+console.log(result);