Release candidate 4 for 1.5.x

appwrite · Feb 21, 2024 · 648d6e4 · 648d6e4
1 parent 83caa55
commit 648d6e4
Show file tree

Hide file tree

Showing 352 changed files with 1,631 additions and 583 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![Maven Central](https://img.shields.io/maven-central/v/io.appwrite/sdk-for-kotlin.svg?color=green&style=flat-square)
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-kotlin.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.4.13-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.5.0-blue.svg?style=flat-square)
 [![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)
 
@@ -39,7 +39,7 @@ repositories {
 Next, add the dependency to your project's `build.gradle(.kts)` file:
 
 ```groovy
-implementation("io.appwrite:sdk-for-kotlin:5.0.0-rc.3")
+implementation("io.appwrite:sdk-for-kotlin:5.0.0-rc.4")
 ```
 
 ### Maven
@@ -50,7 +50,7 @@ Add this to your project's `pom.xml` file:
     <dependency>
         <groupId>io.appwrite</groupId>
         <artifactId>sdk-for-kotlin</artifactId>
-        <version>5.0.0-rc.3</version>
+        <version>5.0.0-rc.4</version>
     </dependency>
 </dependencies>
 ```

diff --git a/docs/examples/java/account/add-authenticator.md b/docs/examples/java/account/add-authenticator.md
@@ -11,7 +11,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.addAuthenticator(
-    AuthenticatorType.TOTP
+    AuthenticatorType.TOTP, // type
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +21,4 @@ account.addAuthenticator(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-email-password-session.md b/docs/examples/java/account/create-email-password-session.md
@@ -9,8 +9,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createEmailPasswordSession(
-    "email@example.com",
-    "password"
+    "email@example.com", // email
+    "password", // password
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.createEmailPasswordSession(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-email-token.md b/docs/examples/java/account/create-email-token.md
@@ -9,8 +9,9 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createEmailToken(
-    "[USER_ID]",
-    "email@example.com",
+    "[USER_ID]", // userId
+    "email@example.com", // email
+    false, // phrase (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +21,4 @@ account.createEmailToken(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-magic-u-r-l-token.md b/docs/examples/java/account/create-magic-u-r-l-token.md
@@ -9,8 +9,10 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createMagicURLToken(
-    "[USER_ID]",
-    "email@example.com",
+    "[USER_ID]", // userId
+    "email@example.com", // email
+    "https://example.com", // url (optional)
+    false, // phrase (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +22,4 @@ account.createMagicURLToken(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-o-auth2session.md b/docs/examples/java/account/create-o-auth2session.md
@@ -10,7 +10,11 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createOAuth2Session(
-    OAuthProvider.AMAZON,
+    OAuthProvider.AMAZON, // provider
+    "https://example.com", // success (optional)
+    "https://example.com", // failure (optional)
+    false, // token (optional)
+    listOf(), // scopes (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +24,4 @@ account.createOAuth2Session(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-phone-token.md b/docs/examples/java/account/create-phone-token.md
@@ -9,8 +9,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createPhoneToken(
-    "[USER_ID]",
-    "+12065550100"
+    "[USER_ID]", // userId
+    "+12065550100", // phone
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.createPhoneToken(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-recovery.md b/docs/examples/java/account/create-recovery.md
@@ -10,8 +10,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createRecovery(
-    "email@example.com",
-    "https://example.com"
+    "email@example.com", // email
+    "https://example.com", // url
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +21,4 @@ account.createRecovery(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-session.md b/docs/examples/java/account/create-session.md
@@ -9,8 +9,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createSession(
-    "[USER_ID]",
-    "[SECRET]"
+    "[USER_ID]", // userId
+    "[SECRET]", // secret
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.createSession(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create-verification.md b/docs/examples/java/account/create-verification.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.createVerification(
-    "https://example.com"
+    "https://example.com", // url
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.createVerification(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create.md b/docs/examples/java/account/create.md
@@ -9,9 +9,10 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.create(
-    "[USER_ID]",
-    "email@example.com",
-    "",
+    "[USER_ID]", // userId
+    "email@example.com", // email
+    "", // password
+    "[NAME]", // name (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +22,4 @@ account.create(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/create2f-a-challenge.md b/docs/examples/java/account/create2f-a-challenge.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.create2FAChallenge(
-    AuthenticationFactor.TOTP
+    AuthenticationFactor.TOTP, // factor
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.create2FAChallenge(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/delete-authenticator.md b/docs/examples/java/account/delete-authenticator.md
@@ -11,8 +11,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.deleteAuthenticator(
-    AuthenticatorType.TOTP,
-    "[OTP]"
+    AuthenticatorType.TOTP, // type
+    "[OTP]", // otp
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -22,3 +22,4 @@ account.deleteAuthenticator(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/delete-identity.md b/docs/examples/java/account/delete-identity.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.deleteIdentity(
-    "[IDENTITY_ID]"
+    "[IDENTITY_ID]", // identityId
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.deleteIdentity(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/delete-session.md b/docs/examples/java/account/delete-session.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.deleteSession(
-    "[SESSION_ID]"
+    "[SESSION_ID]", // sessionId
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.deleteSession(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/get-session.md b/docs/examples/java/account/get-session.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.getSession(
-    "[SESSION_ID]"
+    "[SESSION_ID]", // sessionId
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.getSession(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/list-identities.md b/docs/examples/java/account/list-identities.md
@@ -10,6 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.listIdentities(
+    listOf(), // queries (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -19,3 +20,4 @@ account.listIdentities(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/list-logs.md b/docs/examples/java/account/list-logs.md
@@ -10,6 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.listLogs(
+    listOf(), // queries (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -19,3 +20,4 @@ account.listLogs(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-challenge.md b/docs/examples/java/account/update-challenge.md
@@ -10,8 +10,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updateChallenge(
-    "[CHALLENGE_ID]",
-    "[OTP]"
+    "[CHALLENGE_ID]", // challengeId
+    "[OTP]", // otp
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +21,4 @@ account.updateChallenge(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-email.md b/docs/examples/java/account/update-email.md
@@ -10,8 +10,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updateEmail(
-    "email@example.com",
-    "password"
+    "email@example.com", // email
+    "password", // password
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +21,4 @@ account.updateEmail(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-m-f-a.md b/docs/examples/java/account/update-m-f-a.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updateMFA(
-    false
+    false, // mfa
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.updateMFA(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-magic-u-r-l-session.md b/docs/examples/java/account/update-magic-u-r-l-session.md
@@ -9,8 +9,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updateMagicURLSession(
-    "[USER_ID]",
-    "[SECRET]"
+    "[USER_ID]", // userId
+    "[SECRET]", // secret
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.updateMagicURLSession(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-name.md b/docs/examples/java/account/update-name.md
@@ -10,7 +10,7 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updateName(
-    "[NAME]"
+    "[NAME]", // name
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +20,4 @@ account.updateName(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-password.md b/docs/examples/java/account/update-password.md
@@ -10,7 +10,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updatePassword(
-    "",
+    "", // password
+    "password", // oldPassword (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -20,3 +21,4 @@ account.updatePassword(
         System.out.println(result);
     })
 );
+
diff --git a/docs/examples/java/account/update-phone-verification.md b/docs/examples/java/account/update-phone-verification.md
@@ -10,8 +10,8 @@ Client client = new Client()
 Account account = new Account(client);
 
 account.updatePhoneVerification(
-    "[USER_ID]",
-    "[SECRET]"
+    "[USER_ID]", // userId
+    "[SECRET]", // secret
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
@@ -21,3 +21,4 @@ account.updatePhoneVerification(
         System.out.println(result);
     })
 );
+