Release candidate for 1.5.x

abnegate · abnegate · commit 42f7c0274e3d · 2024-02-27T20:35:57.000+13:00
diff --git a/README.md b/README.md
@@ -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.5")
+implementation("io.appwrite:sdk-for-kotlin:5.0.0-rc.6")
 ```
 
 ### 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.5</version>
+        <version>5.0.0-rc.6</version>
     </dependency>
 </dependencies>
 ```
diff --git a/docs/examples/java/account/update-phone-session.md b/docs/examples/java/account/update-phone-session.md
@@ -1,19 +1,16 @@
 import io.appwrite.Client;
 import io.appwrite.coroutines.CoroutineCallback;
 import io.appwrite.services.Account;
-import io.appwrite.enums.OAuthProvider;
 
 Client client = new Client()
     .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
     .setProject("5df5acd0d48c2"); // Your project ID
 
 Account account = new Account(client);
 
-account.createOAuth2Session(
-    OAuthProvider.AMAZON, // provider
-    "https://example.com", // success (optional)
-    "https://example.com", // failure (optional)
-    listOf(), // scopes (optional)
+account.updatePhoneSession(
+    "<USER_ID>", // userId
+    "<SECRET>", // secret
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
diff --git a/docs/examples/java/messaging/create-email.md b/docs/examples/java/messaging/create-email.md
@@ -19,7 +19,7 @@ messaging.createEmail(
     listOf(), // cc (optional)
     listOf(), // bcc (optional)
     listOf(), // attachments (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     false, // html (optional)
     "", // scheduledAt (optional)
     new CoroutineCallback<>((result, error) -> {
diff --git a/docs/examples/java/messaging/create-push.md b/docs/examples/java/messaging/create-push.md
@@ -24,7 +24,7 @@ messaging.createPush(
     "<COLOR>", // color (optional)
     "<TAG>", // tag (optional)
     "<BADGE>", // badge (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     "", // scheduledAt (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
diff --git a/docs/examples/java/messaging/create-sms.md b/docs/examples/java/messaging/create-sms.md
@@ -15,7 +15,7 @@ messaging.createSms(
     listOf(), // topics (optional)
     listOf(), // users (optional)
     listOf(), // targets (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     "", // scheduledAt (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
diff --git a/docs/examples/java/messaging/update-email.md b/docs/examples/java/messaging/update-email.md
@@ -16,7 +16,7 @@ messaging.updateEmail(
     listOf(), // targets (optional)
     "<SUBJECT>", // subject (optional)
     "<CONTENT>", // content (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     false, // html (optional)
     listOf(), // cc (optional)
     listOf(), // bcc (optional)
diff --git a/docs/examples/java/messaging/update-push.md b/docs/examples/java/messaging/update-push.md
@@ -24,7 +24,7 @@ messaging.updatePush(
     "<COLOR>", // color (optional)
     "<TAG>", // tag (optional)
     0, // badge (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     "", // scheduledAt (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
diff --git a/docs/examples/java/messaging/update-sms.md b/docs/examples/java/messaging/update-sms.md
@@ -15,7 +15,7 @@ messaging.updateSms(
     listOf(), // users (optional)
     listOf(), // targets (optional)
     "<CONTENT>", // content (optional)
-    MessageStatus.DRAFT, // status (optional)
+    false, // draft (optional)
     "", // scheduledAt (optional)
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
diff --git a/docs/examples/java/users/delete-authenticator.md b/docs/examples/java/users/delete-authenticator.md
@@ -13,7 +13,6 @@ Users users = new Users(client);
 users.deleteAuthenticator(
     "<USER_ID>", // userId
     AuthenticatorType.TOTP, // type
-    "<OTP>", // otp
     new CoroutineCallback<>((result, error) -> {
         if (error != null) {
             error.printStackTrace();
diff --git a/docs/examples/kotlin/account/update-phone-session.md b/docs/examples/kotlin/account/update-phone-session.md
@@ -1,17 +1,14 @@
 import io.appwrite.Client
 import io.appwrite.coroutines.CoroutineCallback
 import io.appwrite.services.Account
-import io.appwrite.enums.OAuthProvider
 
 val client = Client()
     .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
     .setProject("5df5acd0d48c2") // Your project ID
 
 val account = Account(client)
 
-account.createOAuth2Session(
-    provider =  OAuthProvider.AMAZON,
-    success = "https://example.com", // optional
-    failure = "https://example.com", // optional
-    scopes = listOf() // optional
+val response = account.updatePhoneSession(
+    userId = "<USER_ID>",
+    secret = "<SECRET>"
 )
diff --git a/docs/examples/kotlin/messaging/create-email.md b/docs/examples/kotlin/messaging/create-email.md
@@ -19,7 +19,7 @@ val response = messaging.createEmail(
     cc = listOf(), // optional
     bcc = listOf(), // optional
     attachments = listOf(), // optional
-    status = "draft", // optional
+    draft = false, // optional
     html = false, // optional
     scheduledAt = "" // optional
 )
diff --git a/docs/examples/kotlin/messaging/create-push.md b/docs/examples/kotlin/messaging/create-push.md
@@ -24,6 +24,6 @@ val response = messaging.createPush(
     color = "<COLOR>", // optional
     tag = "<TAG>", // optional
     badge = "<BADGE>", // optional
-    status = "draft", // optional
+    draft = false, // optional
     scheduledAt = "" // optional
 )
diff --git a/docs/examples/kotlin/messaging/create-sms.md b/docs/examples/kotlin/messaging/create-sms.md
@@ -15,6 +15,6 @@ val response = messaging.createSms(
     topics = listOf(), // optional
     users = listOf(), // optional
     targets = listOf(), // optional
-    status = "draft", // optional
+    draft = false, // optional
     scheduledAt = "" // optional
 )
diff --git a/docs/examples/kotlin/messaging/update-email.md b/docs/examples/kotlin/messaging/update-email.md
@@ -16,7 +16,7 @@ val response = messaging.updateEmail(
     targets = listOf(), // optional
     subject = "<SUBJECT>", // optional
     content = "<CONTENT>", // optional
-    status = "draft", // optional
+    draft = false, // optional
     html = false, // optional
     cc = listOf(), // optional
     bcc = listOf(), // optional
diff --git a/docs/examples/kotlin/messaging/update-push.md b/docs/examples/kotlin/messaging/update-push.md
@@ -24,6 +24,6 @@ val response = messaging.updatePush(
     color = "<COLOR>", // optional
     tag = "<TAG>", // optional
     badge = 0, // optional
-    status = "draft", // optional
+    draft = false, // optional
     scheduledAt = "" // optional
 )
diff --git a/docs/examples/kotlin/messaging/update-sms.md b/docs/examples/kotlin/messaging/update-sms.md
@@ -15,6 +15,6 @@ val response = messaging.updateSms(
     users = listOf(), // optional
     targets = listOf(), // optional
     content = "<CONTENT>", // optional
-    status = "draft", // optional
+    draft = false, // optional
     scheduledAt = "" // optional
 )
diff --git a/docs/examples/kotlin/users/delete-authenticator.md b/docs/examples/kotlin/users/delete-authenticator.md
@@ -12,6 +12,5 @@ val users = Users(client)
 
 val response = users.deleteAuthenticator(
     userId = "<USER_ID>",
-    type =  AuthenticatorType.TOTP,
-    otp = "<OTP>"
+    type =  AuthenticatorType.TOTP
 )
diff --git a/src/main/kotlin/io/appwrite/Client.kt b/src/main/kotlin/io/appwrite/Client.kt
@@ -57,11 +57,11 @@ class Client @JvmOverloads constructor(
     init {
         headers = mutableMapOf(
             "content-type" to "application/json",
-            "user-agent" to "AppwriteKotlinSDK/5.0.0-rc.5 ${System.getProperty("http.agent")}",
+            "user-agent" to "AppwriteKotlinSDK/5.0.0-rc.6 ${System.getProperty("http.agent")}",
             "x-sdk-name" to "Kotlin",
             "x-sdk-platform" to "server",
             "x-sdk-language" to "kotlin",
-            "x-sdk-version" to "5.0.0-rc.5",            "x-appwrite-response-format" to "1.5.0"
+            "x-sdk-version" to "5.0.0-rc.6",            "x-appwrite-response-format" to "1.5.0"
         )
         config = mutableMapOf()
 
diff --git a/src/main/kotlin/io/appwrite/enums/IndexType.kt b/src/main/kotlin/io/appwrite/enums/IndexType.kt
@@ -8,9 +8,7 @@ enum class IndexType(val value: String) {
     @SerializedName("fulltext")
     FULLTEXT("fulltext"),
     @SerializedName("unique")
-    UNIQUE("unique"),
-    @SerializedName("spatial")
-    SPATIAL("spatial");
+    UNIQUE("unique");
 
     override fun toString() = value
 }
diff --git a/src/main/kotlin/io/appwrite/enums/MessageStatus.kt b/src/main/kotlin/io/appwrite/enums/MessageStatus.kt
diff --git a/src/main/kotlin/io/appwrite/services/Account.kt b/src/main/kotlin/io/appwrite/services/Account.kt
@@ -313,7 +313,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Update MFA
      *
-     * 
+     * Enable or disable MFA on an account.
      *
      * @param mfa Enable or disable MFA.
      * @return [io.appwrite.models.User<T>]
@@ -347,7 +347,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Update MFA
      *
-     * 
+     * Enable or disable MFA on an account.
      *
      * @param mfa Enable or disable MFA.
      * @return [io.appwrite.models.User<T>]
@@ -396,7 +396,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Create MFA Challenge (confirmation)
      *
-     * 
+     * Complete the MFA challenge by providing the one-time password.
      *
      * @param challengeId ID of the challenge.
      * @param otp Valid verification token.
@@ -428,7 +428,7 @@ class Account(client: Client) : Service(client) {
     /**
      * List Factors
      *
-     * 
+     * List the factors available on the account to be used as a MFA challange.
      *
      * @return [io.appwrite.models.MfaFactors]
      */
@@ -458,7 +458,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Add Authenticator
      *
-     * 
+     * Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator) method.
      *
      * @param type Type of authenticator.
      * @return [io.appwrite.models.MfaType]
@@ -491,7 +491,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Verify Authenticator
      *
-     * 
+     * Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#addAuthenticator) method.
      *
      * @param type Type of authenticator.
      * @param otp Valid verification token.
@@ -528,7 +528,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Verify Authenticator
      *
-     * 
+     * Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#addAuthenticator) method.
      *
      * @param type Type of authenticator.
      * @param otp Valid verification token.
@@ -547,7 +547,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Delete Authenticator
      *
-     * 
+     * Delete an authenticator for a user by ID.
      *
      * @param type Type of authenticator.
      * @param otp Valid verification token.
@@ -584,7 +584,7 @@ class Account(client: Client) : Service(client) {
     /**
      * Delete Authenticator
      *
-     * 
+     * Delete an authenticator for a user by ID.
      *
      * @param type Type of authenticator.
      * @param otp Valid verification token.
@@ -1056,7 +1056,7 @@ class Account(client: Client) : Service(client) {
     }
 
     /**
-     * Create session (deprecated)
+     * Update magic URL session
      *
      * Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.
      *
@@ -1092,40 +1092,38 @@ class Account(client: Client) : Service(client) {
     }
 
     /**
-     * Create OAuth2 session
+     * Update phone session
      *
-     * Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL&#039;s back to your app when login is completed.If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
+     * Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.
      *
-     * @param provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
-     * @param success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
-     * @param failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
-     * @param scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
-     * @return [String]
+     * @param userId User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param secret Valid verification token.
+     * @return [io.appwrite.models.Session]
      */
-    @JvmOverloads
     @Throws(AppwriteException::class)
-    suspend fun createOAuth2Session(
-        provider: OAuthProvider,
-        success: String? = null,
-        failure: String? = null,
-        scopes: List<String>? = null,
-    ): String {
-        val apiPath = "/account/sessions/oauth2/{provider}"
-            .replace("{provider}", provider.value)
+    suspend fun updatePhoneSession(
+        userId: String,
+        secret: String,
+    ): io.appwrite.models.Session {
+        val apiPath = "/account/sessions/phone"
 
         val apiParams = mutableMapOf<String, Any?>(
-            "success" to success,
-            "failure" to failure,
-            "scopes" to scopes,
+            "userId" to userId,
+            "secret" to secret,
         )
         val apiHeaders = mutableMapOf(
             "content-type" to "application/json",
         )
-        return client.redirect(
-            "GET",
+        val converter: (Any) -> io.appwrite.models.Session = {
+            io.appwrite.models.Session.from(map = it as Map<String, Any>)
+        }
+        return client.call(
+            "PUT",
             apiPath,
             apiHeaders,
-            apiParams
+            apiParams,
+            responseType = io.appwrite.models.Session::class.java,
+            converter,
         )
     }
 
@@ -1199,7 +1197,7 @@ class Account(client: Client) : Service(client) {
     }
 
     /**
-     * Update (or renew) a session
+     * Update (or renew) session
      *
      * Extend session&#039;s expiry to increase it&#039;s lifespan. Extending a session is useful when session length is short such as 5 minutes.
      *
diff --git a/src/main/kotlin/io/appwrite/services/Databases.kt b/src/main/kotlin/io/appwrite/services/Databases.kt
diff --git a/src/main/kotlin/io/appwrite/services/Health.kt b/src/main/kotlin/io/appwrite/services/Health.kt
diff --git a/src/main/kotlin/io/appwrite/services/Messaging.kt b/src/main/kotlin/io/appwrite/services/Messaging.kt
diff --git a/src/main/kotlin/io/appwrite/services/Users.kt b/src/main/kotlin/io/appwrite/services/Users.kt
