Release candidate 4 for 1.5.x

appwrite · Feb 21, 2024 · adbb8c1 · adbb8c1
1 parent 9c484cb
commit adbb8c1
Show file tree

Hide file tree

Showing 39 changed files with 330 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![Swift Package Manager](https://img.shields.io/github/v/release/appwrite/sdk-for-apple.svg?color=green&style=flat-square)
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-apple.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)
 [![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)
@@ -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.3"),
+        .package(url: "[email protected]:appwrite/sdk-for-apple.git", from: "5.0.0-rc.4"),
     ],
 ```
 

diff --git a/Sources/Appwrite/Client.swift b/Sources/Appwrite/Client.swift
@@ -25,7 +25,7 @@ open class Client {
         "x-sdk-name": "Apple",
         "x-sdk-platform": "client",
         "x-sdk-language": "apple",
-        "x-sdk-version": "5.0.0-rc.3",
+        "x-sdk-version": "5.0.0-rc.4",
         "x-appwrite-response-format": "1.5.0"
     ]
 

diff --git a/Sources/Appwrite/Services/Messaging.swift b/Sources/Appwrite/Services/Messaging.swift
@@ -9,7 +9,9 @@ import AppwriteModels
 open class Messaging: Service {
 
     ///
-    /// Create a subscriber.
+    /// Create a subscriber
+    ///
+    /// Create a new subscriber.
     ///
     /// @param String topicId
     /// @param String subscriberId
@@ -48,7 +50,9 @@ open class Messaging: Service {
     }
 
     ///
-    /// Delete a subscriber.
+    /// Delete a subscriber
+    ///
+    /// Delete a subscriber by its unique ID.
     ///
     /// @param String topicId
     /// @param String subscriberId

diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md
@@ -8,6 +8,7 @@ let account = Account(client)
 
 let token = try await account.createEmailToken(
     userId: "[USER_ID]",
-    email: "[email protected]"
+    email: "[email protected]",
+    phrase: false // optional
 )
 
diff --git a/docs/examples/account/create-magic-u-r-l-token.md b/docs/examples/account/create-magic-u-r-l-token.md
@@ -8,6 +8,8 @@ let account = Account(client)
 
 let token = try await account.createMagicURLToken(
     userId: "[USER_ID]",
-    email: "[email protected]"
+    email: "[email protected]",
+    url: "https://example.com", // optional
+    phrase: false // optional
 )
 
diff --git a/docs/examples/account/create-o-auth2session.md b/docs/examples/account/create-o-auth2session.md
@@ -8,6 +8,10 @@ let client = Client()
 let account = Account(client)
 
 let success = try await account.createOAuth2Session(
-    provider: .amazon
+    provider: .amazon,
+    success: "https://example.com", // optional
+    failure: "https://example.com", // optional
+    token: false, // optional
+    scopes: [] // optional
 )
 
diff --git a/docs/examples/account/create-push-target.md b/docs/examples/account/create-push-target.md
@@ -8,6 +8,7 @@ let account = Account(client)
 
 let target = try await account.createPushTarget(
     targetId: "[TARGET_ID]",
-    identifier: "[IDENTIFIER]"
+    identifier: "[IDENTIFIER]",
+    providerId: "[PROVIDER_ID]" // optional
 )
 
diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md
@@ -9,6 +9,7 @@ let account = Account(client)
 let user = try await account.create(
     userId: "[USER_ID]",
     email: "[email protected]",
-    password: ""
+    password: "",
+    name: "[NAME]" // optional
 )
 
diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md
@@ -6,5 +6,7 @@ let client = Client()
 
 let account = Account(client)
 
-let identityList = try await account.listIdentities()
+let identityList = try await account.listIdentities(
+    queries: [] // optional
+)
 
diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md
@@ -6,5 +6,7 @@ let client = Client()
 
 let account = Account(client)
 
-let logList = try await account.listLogs()
+let logList = try await account.listLogs(
+    queries: [] // optional
+)
 
diff --git a/docs/examples/account/update-m-f-a.md b/docs/examples/account/update-m-f-a.md
@@ -7,6 +7,6 @@ let client = Client()
 let account = Account(client)
 
 let user = try await account.updateMFA(
-    mfa: `false`
+    mfa: false
 )
 
diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md
@@ -7,6 +7,7 @@ let client = Client()
 let account = Account(client)
 
 let user = try await account.updatePassword(
-    password: ""
+    password: "",
+    oldPassword: "password" // optional
 )
 
diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md
@@ -8,6 +8,9 @@ let client = Client()
 let avatars = Avatars(client)
 
 let bytes = try await avatars.getBrowser(
-    code: .avantBrowser
+    code: .avantBrowser,
+    width: 0, // optional
+    height: 0, // optional
+    quality: 0 // optional
 )
 
diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md
@@ -8,6 +8,9 @@ let client = Client()
 let avatars = Avatars(client)
 
 let bytes = try await avatars.getCreditCard(
-    code: .americanExpress
+    code: .americanExpress,
+    width: 0, // optional
+    height: 0, // optional
+    quality: 0 // optional
 )
 
diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md
@@ -8,6 +8,9 @@ let client = Client()
 let avatars = Avatars(client)
 
 let bytes = try await avatars.getFlag(
-    code: .afghanistan
+    code: .afghanistan,
+    width: 0, // optional
+    height: 0, // optional
+    quality: 0 // optional
 )
 
diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md
@@ -7,6 +7,8 @@ let client = Client()
 let avatars = Avatars(client)
 
 let bytes = try await avatars.getImage(
-    url: "https://example.com"
+    url: "https://example.com",
+    width: 0, // optional
+    height: 0 // optional
 )
 
diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md
@@ -6,5 +6,10 @@ let client = Client()
 
 let avatars = Avatars(client)
 
-let bytes = try await avatars.getInitials()
+let bytes = try await avatars.getInitials(
+    name: "[NAME]", // optional
+    width: 0, // optional
+    height: 0, // optional
+    background: "" // optional
+)
 
diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md
@@ -7,6 +7,9 @@ let client = Client()
 let avatars = Avatars(client)
 
 let bytes = try await avatars.getQR(
-    text: "[TEXT]"
+    text: "[TEXT]",
+    size: 1, // optional
+    margin: 0, // optional
+    download: false // optional
 )
 
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -10,6 +10,7 @@ let document = try await databases.createDocument(
     databaseId: "[DATABASE_ID]",
     collectionId: "[COLLECTION_ID]",
     documentId: "[DOCUMENT_ID]",
-    data: [:]
+    data: [:],
+    permissions: ["read("any")"] // optional
 )
 
diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md
@@ -9,6 +9,7 @@ let databases = Databases(client)
 let document = try await databases.getDocument(
     databaseId: "[DATABASE_ID]",
     collectionId: "[COLLECTION_ID]",
-    documentId: "[DOCUMENT_ID]"
+    documentId: "[DOCUMENT_ID]",
+    queries: [] // optional
 )
 
diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md
@@ -8,6 +8,7 @@ let databases = Databases(client)
 
 let documentList = try await databases.listDocuments(
     databaseId: "[DATABASE_ID]",
-    collectionId: "[COLLECTION_ID]"
+    collectionId: "[COLLECTION_ID]",
+    queries: [] // optional
 )
 
diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md
@@ -9,6 +9,8 @@ let databases = Databases(client)
 let document = try await databases.updateDocument(
     databaseId: "[DATABASE_ID]",
     collectionId: "[COLLECTION_ID]",
-    documentId: "[DOCUMENT_ID]"
+    documentId: "[DOCUMENT_ID]",
+    data: [:], // optional
+    permissions: ["read("any")"] // optional
 )
 
diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md
@@ -7,6 +7,11 @@ let client = Client()
 let functions = Functions(client)
 
 let execution = try await functions.createExecution(
-    functionId: "[FUNCTION_ID]"
+    functionId: "[FUNCTION_ID]",
+    body: "[BODY]", // optional
+    async: false, // optional
+    path: "[PATH]", // optional
+    method: .gET, // optional
+    headers: [:] // optional
 )
 
diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md
@@ -7,6 +7,8 @@ let client = Client()
 let functions = Functions(client)
 
 let executionList = try await functions.listExecutions(
-    functionId: "[FUNCTION_ID]"
+    functionId: "[FUNCTION_ID]",
+    queries: [], // optional
+    search: "[SEARCH]" // optional
 )
 
diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md
@@ -9,6 +9,7 @@ let storage = Storage(client)
 let file = try await storage.createFile(
     bucketId: "[BUCKET_ID]",
     fileId: "[FILE_ID]",
-    file: InputFile.fromPath("file.png")
+    file: InputFile.fromPath("file.png"),
+    permissions: ["read("any")"] // optional
 )
 
diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md
@@ -8,6 +8,17 @@ let storage = Storage(client)
 
 let bytes = try await storage.getFilePreview(
     bucketId: "[BUCKET_ID]",
-    fileId: "[FILE_ID]"
+    fileId: "[FILE_ID]",
+    width: 0, // optional
+    height: 0, // optional
+    gravity: .center, // optional
+    quality: 0, // optional
+    borderWidth: 0, // optional
+    borderColor: "", // optional
+    borderRadius: 0, // optional
+    opacity: 0, // optional
+    rotation: -360, // optional
+    background: "", // optional
+    output: .jpg // optional
 )
 
diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md
@@ -7,6 +7,8 @@ let client = Client()
 let storage = Storage(client)
 
 let fileList = try await storage.listFiles(
-    bucketId: "[BUCKET_ID]"
+    bucketId: "[BUCKET_ID]",
+    queries: [], // optional
+    search: "[SEARCH]" // optional
 )
 
diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md
@@ -8,6 +8,8 @@ let storage = Storage(client)
 
 let file = try await storage.updateFile(
     bucketId: "[BUCKET_ID]",
-    fileId: "[FILE_ID]"
+    fileId: "[FILE_ID]",
+    name: "[NAME]", // optional
+    permissions: ["read("any")"] // optional
 )
 
diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md
@@ -8,6 +8,11 @@ let teams = Teams(client)
 
 let membership = try await teams.createMembership(
     teamId: "[TEAM_ID]",
-    roles: []
+    roles: [],
+    email: "[email protected]", // optional
+    userId: "[USER_ID]", // optional
+    phone: "+12065550100", // optional
+    url: "https://example.com", // optional
+    name: "[NAME]" // optional
 )
 
diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md
@@ -8,6 +8,7 @@ let teams = Teams(client)
 
 let team = try await teams.create(
     teamId: "[TEAM_ID]",
-    name: "[NAME]"
+    name: "[NAME]",
+    roles: [] // optional
 )
 
diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md
@@ -7,6 +7,8 @@ let client = Client()
 let teams = Teams(client)
 
 let membershipList = try await teams.listMemberships(
-    teamId: "[TEAM_ID]"
+    teamId: "[TEAM_ID]",
+    queries: [], // optional
+    search: "[SEARCH]" // optional
 )
 
diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md
@@ -6,5 +6,8 @@ let client = Client()
 
 let teams = Teams(client)
 
-let teamList = try await teams.list()
+let teamList = try await teams.list(
+    queries: [], // optional
+    search: "[SEARCH]" // optional
+)