Release candidate for 1.5.x

Author: abnegate

README.md

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

Sources/Appwrite/Client.swift

@@ -23,7 +23,7 @@ open class Client {
         "x-sdk-name": "Apple",
         "x-sdk-platform": "client",
         "x-sdk-language": "apple",
-        "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
@@ -1254,6 +1279,46 @@ open class Account: Service {
         return true
     }
 
+    ///
+    /// Update phone 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.
+    ///
+    /// @param String userId
+    /// @param String secret
+    /// @throws Exception
+    /// @return array
+    ///
+    open func updatePhoneSession(
+        userId: String,
+        secret: String
+    ) async throws -> AppwriteModels.Session {
+        let apiPath: String = "/account/sessions/phone"
+
+        let apiParams: [String: Any?] = [
+            "userId": userId,
+            "secret": secret
+        ]
+
+        let apiHeaders: [String: String] = [
+            "content-type": "application/json"
+        ]
+
+        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,
+            converter: converter
+        )
+    }
+
     ///
     /// Create session
     ///
@@ -1330,7 +1395,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.
@@ -1448,7 +1513,7 @@ open class Account: Service {
     }
 
     ///
-    /// Create a push target
+    /// Create push target
     ///
     /// @param String targetId
     /// @param String identifier
@@ -1487,7 +1552,7 @@ open class Account: Service {
     }
 
     ///
-    /// Update a push target
+    /// Update push target
     ///
     /// @param String targetId
     /// @param String identifier
@@ -1523,7 +1588,7 @@ open class Account: Service {
     }
 
     ///
-    /// Delete a push target
+    /// Delete push target
     ///
     /// @param String targetId
     /// @throws Exception

Sources/Appwrite/Services/Messaging.swift

@@ -9,7 +9,7 @@ import AppwriteModels
 open class Messaging: Service {
 
     ///
-    /// Create a subscriber
+    /// Create subscriber
     ///
     /// Create a new subscriber.
     ///
@@ -50,7 +50,7 @@ open class Messaging: Service {
     }
 
     ///
-    /// Delete a subscriber
+    /// Delete subscriber
     ///
     /// Delete a subscriber by its unique ID.
     ///

docs/examples/account/update-phone-session.md

@@ -0,0 +1,13 @@
+import Appwrite
+
+let client = Client()
+    .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
+    .setProject("5df5acd0d48c2") // Your project ID
+
+let account = Account(client)
+
+let session = try await account.updatePhoneSession(
+    userId: "<USER_ID>",
+    secret: "<SECRET>"
+)
+

docs/examples/functions/create-execution.md

@@ -1,4 +1,5 @@
 import Appwrite
+import AppwriteEnums
 
 let client = Client()
     .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint

docs/examples/storage/get-file-preview.md

@@ -1,4 +1,6 @@
 import Appwrite
+import AppwriteEnums
+import AppwriteEnums
 
 let client = Client()
     .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint