Release candidate for 1.5.x

Author: abnegate

README.md

@@ -33,7 +33,7 @@ Add the package to your `Package.swift` dependencies:
 
 ```swift
     dependencies: [
-        .package(url: "git@github.com:appwrite/sdk-for-swift.git", from: "5.0.0-rc.5"),
+        .package(url: "git@github.com:appwrite/sdk-for-swift.git", from: "5.0.0-rc.6"),
     ],
 ```
 

Sources/Appwrite/Client.swift

@@ -21,7 +21,7 @@ open class Client {
         "x-sdk-name": "Swift",
         "x-sdk-platform": "server",
         "x-sdk-language": "swift",
-        "x-sdk-version": "5.0.0-rc.5",
+        "x-sdk-version": "5.0.0-rc.6",
         "x-appwrite-response-format": "1.5.0"
     ]
 

Sources/Appwrite/Services/Account.swift

@@ -350,6 +350,8 @@ open class Account: Service {
     ///
     /// Update MFA
     ///
+    /// Enable or disable MFA on an account.
+    ///
     /// @param Bool mfa
     /// @throws Exception
     /// @return array
@@ -384,6 +386,8 @@ open class Account: Service {
     ///
     /// Update MFA
     ///
+    /// Enable or disable MFA on an account.
+    ///
     /// @param Bool mfa
     /// @throws Exception
     /// @return array
@@ -433,6 +437,8 @@ open class Account: Service {
     ///
     /// Create MFA Challenge (confirmation)
     ///
+    /// Complete the MFA challenge by providing the one-time password.
+    ///
     /// @param String challengeId
     /// @param String otp
     /// @throws Exception
@@ -463,6 +469,8 @@ open class Account: Service {
     ///
     /// List Factors
     ///
+    /// List the factors available on the account to be used as a MFA challange.
+    ///
     /// @throws Exception
     /// @return array
     ///
@@ -492,6 +500,11 @@ open class Account: Service {
     ///
     /// 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 AppwriteEnums.AuthenticatorType type
     /// @throws Exception
     /// @return array
@@ -524,6 +537,10 @@ open class Account: Service {
     ///
     /// Verify Authenticator
     ///
+    /// Verify an authenticator app after adding it using the [add
+    /// authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+    /// method.
+    ///
     /// @param AppwriteEnums.AuthenticatorType type
     /// @param String otp
     /// @throws Exception
@@ -561,6 +578,10 @@ open class Account: Service {
     ///
     /// Verify Authenticator
     ///
+    /// Verify an authenticator app after adding it using the [add
+    /// authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+    /// method.
+    ///
     /// @param AppwriteEnums.AuthenticatorType type
     /// @param String otp
     /// @throws Exception
@@ -580,6 +601,8 @@ open class Account: Service {
     ///
     /// Delete Authenticator
     ///
+    /// Delete an authenticator for a user by ID.
+    ///
     /// @param AppwriteEnums.AuthenticatorType type
     /// @param String otp
     /// @throws Exception
@@ -617,6 +640,8 @@ open class Account: Service {
     ///
     /// Delete Authenticator
     ///
+    /// Delete an authenticator for a user by ID.
+    ///
     /// @param AppwriteEnums.AuthenticatorType type
     /// @param String otp
     /// @throws Exception
@@ -1158,7 +1183,7 @@ open class Account: Service {
     }
 
     ///
-    /// 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
@@ -1198,57 +1223,42 @@ open class Account: Service {
     }
 
     ///
-    /// 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'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 AppwriteEnums.OAuthProvider provider
-    /// @param String success
-    /// @param String failure
-    /// @param [String] scopes
+    /// @param String userId
+    /// @param String secret
     /// @throws Exception
     /// @return array
     ///
-    open func createOAuth2Session(
-        provider: AppwriteEnums.OAuthProvider,
-        success: String? = nil,
-        failure: String? = nil,
-        scopes: [String]? = nil
-    ) async throws -> String? {
-        let apiPath: String = "/account/sessions/oauth2/{provider}"
-            .replacingOccurrences(of: "{provider}", with: provider.rawValue)
+    open func updatePhoneSession(
+        userId: String,
+        secret: String
+    ) async throws -> AppwriteModels.Session {
+        let apiPath: String = "/account/sessions/phone"
 
         let apiParams: [String: Any?] = [
-            "success": success,
-            "failure": failure,
-            "scopes": scopes,
-            "project": client.config["project"]
+            "userId": userId,
+            "secret": secret
         ]
 
         let apiHeaders: [String: String] = [
             "content-type": "application/json"
         ]
 
-        return try await client.redirect(
-            method: "GET",
+        let converter: (Any) -> AppwriteModels.Session = { response in
+            return AppwriteModels.Session.from(map: response as! [String: Any])
+        }
+
+        return try await client.call(
+            method: "PUT",
             path: apiPath,
             headers: apiHeaders,
-            params: apiParams
+            params: apiParams,
+            converter: converter
         )
     }
 
@@ -1328,7 +1338,7 @@ open class Account: Service {
     }
 
     ///
-    /// Update (or renew) a session
+    /// Update (or renew) session
     ///
     /// Extend session's expiry to increase it's lifespan. Extending a session is
     /// useful when session length is short such as 5 minutes.

Sources/Appwrite/Services/Databases.swift

@@ -412,6 +412,8 @@ open class Databases: Service {
     ///
     /// List attributes
     ///
+    /// List attributes in the collection.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param [String] queries
@@ -502,6 +504,9 @@ open class Databases: Service {
     ///
     /// Update boolean attribute
     ///
+    /// Update a boolean attribute. Changing the `default` value will not update
+    /// already existing documents.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -547,6 +552,8 @@ open class Databases: Service {
     ///
     /// Create datetime attribute
     ///
+    /// Create a date time attribute according to the ISO 8601 standard.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -595,6 +602,9 @@ open class Databases: Service {
     ///
     /// Update dateTime attribute
     ///
+    /// Update a date time attribute. Changing the `default` value will not update
+    /// already existing documents.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -740,6 +750,10 @@ open class Databases: Service {
     ///
     /// Create enum attribute
     ///
+    /// Create an enumeration attribute. The `elements` param acts as a white-list
+    /// of accepted values for this attribute. 
+    /// 
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -1433,6 +1447,8 @@ open class Databases: Service {
     ///
     /// Get attribute
     ///
+    /// Get attribute by ID.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -1465,6 +1481,8 @@ open class Databases: Service {
     ///
     /// Delete attribute
     ///
+    /// Deletes an attribute.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -1883,6 +1901,8 @@ open class Databases: Service {
     ///
     /// List indexes
     ///
+    /// List indexes in the collection.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param [String] queries
@@ -1922,6 +1942,10 @@ open class Databases: Service {
     ///
     /// Create index
     ///
+    /// Creates an index on the attributes listed. Your index should include all
+    /// the attributes you will query in a single request.
+    /// Attributes can be `key`, `fulltext`, and `unique`.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -1970,6 +1994,8 @@ open class Databases: Service {
     ///
     /// Get index
     ///
+    /// Get index by ID.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key
@@ -2008,6 +2034,8 @@ open class Databases: Service {
     ///
     /// Delete index
     ///
+    /// Delete an index.
+    ///
     /// @param String databaseId
     /// @param String collectionId
     /// @param String key

Sources/Appwrite/Services/Health.swift

@@ -421,6 +421,9 @@ open class Health: Service {
     ///
     /// Get functions queue
     ///
+    /// Get the number of function executions that are waiting to be processed in
+    /// the Appwrite internal queue server.
+    ///
     /// @param Int threshold
     /// @throws Exception
     /// @return array